To facilitate a smooth and rapid integration process, we have prepared comprehensive API documentation and testing resources. These assets will help your development team understand endpoints, request/response structures, and authentication mechanisms with minimal friction.
Swagger Documentation #
We use Swagger (OpenAPI Specification) to describe and visualize integration API. The interactive Swagger UI allows you to explore all available endpoints, view detailed schema definitions for requests and responses, and perform live API test calls directly from your browser.
You can download the raw OpenAPI definition file below.
Postman Collection & Environment #
For rapid prototyping and manual testing, we have provided a pre-configured Postman Collection. This collection includes:
- Pre-configured requests for all API endpoints.
- Example request payloads and header configurations.
- A pre-defined Postman Environment template to easily switch between your Staging and Production variables (e.g., URL, api-key).
You can download the Postman Collection and Enviroment file below.