Postman collection
To explore the API without writing code, import its routes into Postman. There are two ways; the first covers the whole API.
Use an mk_test_... key from an account in test mode: messages are simulated and no money moves.
Option 1: import the live OpenAPI document
The platform publishes the public-v1 OpenAPI document (only /api/v1/*) at the root of your host:
{BASE}/swagger/public-v1/swagger.json
- In Postman, Import and paste that address as a link (or download the JSON and import it as a file).
- In the collection created, Authorization tab: type Bearer Token with your key (
mk_...) or an OAuth2 token. - Check that the requests' base address is your platform's.
Because it is generated by the service itself, it also includes the Management API and stays up to date with every release. The same reference, with an interactive viewer, is at {BASE}/docs/api-v1 (see Public API).
Option 2: ready-made collection
IncentIA generates the incentia-public-v1.postman_collection.json collection from the repository's versioned OpenAPI document. Each request is grouped by tag and the API version is in the collection's info.version. Ask your IncentIA contact for it if you need it.
When you import it, set two collection variables:
| Variable | Value |
|---|---|
baseUrl | Your platform's address, no trailing slash |
apiKey | Your API key (do not share it or commit it to a repository) |
The collection already sends Authorization: Bearer {{apiKey}} on every request.
The versioned document this collection is based on currently covers members, point transactions, till coupon redemption, evidence (/api/v1/claims) and webhook redelivery. It does not include programmes, tiers, campaigns, rewards, coupon management, raffles or member attributes: use option 1 for those.