In general, these are the steps on how to integrate with Xendit Data Services. Please kindly be noted that the integration only can be done via API using the programming language JSON.
Getting set up
Iluma data products use a RESTful API design to make them cleaner and easier to understand. All the API requests should be made over HTTPS instead of HTTP (all calls made over plain HTTP will fail). All our API responses will return JSON objects which can be consumed by your application. Responses will typically be delivered via callback, though some products also offer to GET endpoints which you can poll to retrieve the status of a request.
In short, we have three steps to help you set up:
- Getting sample code
- Authenticating your requests
- Setting callbacks
For all detailed information on the steps, please visit our documentation here.
Making your first request
Once you
- Have an API key
- Have a callback server
- Have set up callbacks
You are now set up to make requests to the Iluma data product APIs. The latest list of endpoints is available here, with instructions on specific request and response formats. Generalized error formats apply across all endpoints and are available here.
In order to make your first request, please ensure you've registered in Xendit Data Services and got the required access. Please contact your AM/SR or help@xendit.co / help@iluma.ai to start onboarding with XDS.
Important: Note that all requests made in the development environment will hit dummy data.
For detailed information regarding the steps, you may visit our documentation here
Simulating responses
When we receive a request with a "Magic Reply" header, we will return a response of a specific format, allowing you to simulate the major response payloads that you would receive when querying a resource with that state. If the response state would normally trigger a callback, this will also be sent to the server you specified during setup.
Note that:
- Requests made to validation endpoints (e.g.: e-wallet name validation) will mirror your request payload
- Requests made to data extraction endpoints (e.g., ID card OCR) will return dummy data
- Format validation will be applied before assessing the magic reply header, so you will receive
API_VALIDATION_ERROR
if you provide a request payload that doesn't comply with the API specification - These headers are available on BOTH
development
andlive
environments - Requests made with these headers will NOT be charged in the
live
environment
For detailed information regarding simulating responses, you may visit our documentation here.
For detailed information regarding Magic Reply, you may visit our documentation here.