A comprehensive documentation guide to find all the assets required to conduct a successful integration with Toqio
Toqio’s Integration Hub is a cloud software that allows you to integrate into Toqio’s ecosystem the services catalogue of a financial provider.
An integration would be then, a piece of software that enables the communication between Toqio and a financial provider and it’s developed by a third party.
The integration will receive requests from Toqio, will process these requests and will send them to the financial provider. Likewise, the integration will receive communications from the financial service and will send them to Toqio after processing them. We could think about the integration hub as a translation system between Toqio and the financial provider.
Based on the above definitions, there are some critical points that are required to connect and use Toqio’s Integration Hub:
- All the requests the integration gets from Toqio and sent to Toqio must be authenticated and encrypted.
- The integrator must assess the financial provider’s API and implement the communication in the integration. The integration will react to Toqio’s requests sending petitions to the financial provider API accordingly. As an example, a user creates an account in the application so Toqio orchestration will process the request and will send it from the Integration Hub to the integration. The integration will translate the request to the financial provider’s interface and will send it over the API.
- The above also implies that a double authentication system must be implemented, the one Toqio requires and the authentication method defined by the financial provider.
- The integration will be invoked by the financial provider and must process their requests and send the updates over Toqio’s webhook service. These requests must be asynchronous and won’t be possible to obtain information stored in Toqio. See further details about Toqio webhooks service in this article.
- All the data required for your internal processes must be stored in the integration database or requesting them to the financial provider API.
- The integration must implement a set of endpoints that will receive requests from Toqio, according to the definition of the API and will respond with the interface also defined in each endpoint.
- As an integrator you don’t need to implement all the endpoints in Toqio’s Integration Hub. You must implement mandatory endpoints listed in this article and the endpoints that your integration could use from the ones that are optional in the endpoints catalogue.