In order to distribute your data via API on the platform, your organization must have an API management system with which it is possible to interface. In this case, the Data Exchange Platform plays the role of a trusted intermediary, handling access to your API for each acquirer and enabling control and filtering of consumed data.
Create an offering by API
Create a new data offer from Publication > Data offerings > Add an offering. Choose one of the two available API distribution modes: “Pull API” or “Push API”.
Access to this feature depends on your subscription to the platform. To find out what your current plan is, click on your name > "Your organization", and review the "Subscription plan and quotas" box, or get in touch with our support team.
How to choose between API Pull and API Push?
These two distribution modes change the way the acquirer will have access to your data:
- Pull API: once the transaction is finalized, the acquirer queries your API according to their needs. A specific endpoint is provided automatically by the platform to each acquirer, enabling them to query your endpoint. The platform verifies the authorized number of requests and query frequency for each endpoint.
- Push API: as the data provider, you send your data to the endpoint provided by the platform when you are ready. The platform then handles distribution of that data to each acquirer according to their subscription and preferences.
What information needs to be prepared?
You must provide the same information as for a file-based data offering, as well as specific information related to your API (endpoints, parameters, codes, documentation, etc.).