Mikono API
The Mikono API lets another system read and write a distributor’s records in Mikono: outlets, products, prices, routes, orders, invoices, returns, collections, stock and trips. It also receives documents from a distributor management system and returns an update flag for each.
It is a JSON API over HTTPS. Keys are issued per organisation, every create is idempotent, changes can be read as a feed or received as signed webhooks, and records can be found by your own codes as well as by Mikono’s IDs.
Sandbox base URL
https://calculating-gnu-991.convex.site/api/v1Version
1.13.0Guides
- Getting startedThis guide takes you from no key to a first successful call. You get a sandbox key, call GET /me with curl, and find the call in the organisation's API log.
- Authentication and keysThis guide explains how API keys work: how to send one, which scopes a key can hold, and how rotation, revocation, expiry and the IP allowlist behave.
- Environments and the sandboxMikono has a sandbox and a production environment, each with its own base URL and its own keys. This guide explains the difference and what the sandbox organisation holds.
- IdempotencyEvery request that creates a record carries an Idempotency-Key, so a retry after a timeout never creates a second record. This guide explains the header and how Mikono answers a repeated key.
- Pagination and change feedsList endpoints return records a page at a time with an opaque cursor. With updatedSince, the same mechanism becomes a change feed you can resume. This guide explains both.
- ErrorsEvery error is a JSON problem document with a stable code. This guide explains the format and lists every code the API returns.
- Rate limitsEach key has its own request limits. This guide gives the limits, the headers that report them, and how to back off when you reach one.
- WebhooksWebhooks tell your system when a record changes in Mikono. This guide lists the events, shows how to verify the signature on each delivery, and explains retries.
- External codesRecords can be read, matched and updated by your own codes, such as a DMS outlet code, as well as by Mikono's ID. This guide explains how codes are stored, looked up and kept unique.
- DMS integrationThis guide is for distributor management system (DMS) teams. It covers how to send documents to Mikono, the update flags Mikono returns, the reason codes, duplicate document numbers, and what is planned: SFTP transfer and the daily reconciliation.
- ChangelogEvery change to the API, newest first. The newest version number here is the version in the OpenAPI document.
Reference
The API reference lists every endpoint with its fields, examples and errors, and lets you send requests with your key. It is generated from the OpenAPI 3.1 document, which you can download to generate a client.