Here’s the process to follow to build a provider implementation for a service
Read Provider APIs: First read through the provider’s API docs, digest and understand it.
Test Provider APIs: Create a collection of the provider’s APIs, test them against their test environment and get responses for every endpoint. Save this responses and create mocks. Save the final functional collection in the Provider APIs workspace on the OnePipe Postman account.
Understand the standard OnePipe payloads: See here
Core service description: Now, identify the service you want to implement. Thoroughly read and understand it’s service description. If it doesn’t exist for the service you are thinking of implementing, contact Hussein Alayo or Victor Irechukwu to write it up. Don’t continue till this is done.
Create your own service description: Make a copy of the service description, name it {{provider}} {{service}}. Save as a child page of the service description. This should be based on your understanding of the service versus the provider’s internal APIs, ensure that your provider service description has the following components:
Settlement and fees model
Process flows and sequence of API calls
Any special notes.
List out what needs to be configured in provider override settings
Don’t continue till this is done.
Review the design: Review this design with at least 2 people. Discuss the settlement modalities with Victor Irechukwu and Yvonne to ensure it works out.
Write your code: Go ahead and build your provider
Write code
Test on dev (inspect)
Test on dev (live)
Promote and Test on staging
Promote and Test on production
Add Comment