Developers
Build on Uncart
The Uncart API connects Uncart to a shop system it has no ready-made integration for. These pages are for the developer who writes that connection.
How it works
Your server calls the API over HTTPS, with a secret key in the Authorization header. The key belongs to one shop and works in one mode, live or test, and every route answers for that shop and that mode alone. The API reference lists every route there is, each with an example that Uncart's tests run against the API.
Uncart builds every link in its messages. Each one leads to a page on a domain you verified, and the redirect adds a click id that your order report sends back. Uncart matches the order to the link, and that match is what your shop is billed on.
What to read
- The quickstart gets you a test key and a first answer.
- Test mode explains the free sandbox. Build the whole connection there before you touch live data.
- Authentication and keys covers the kinds of key, their scopes, and rotation.
- Verified domains shows the DNS record or the file that proves you own a domain.
- Links and the click id says which addresses Uncart will link to and what arrives on your page.
Errors, Rate limits, Idempotency and Versioning cover what every route shares. The changelog records each change to the API.
Conventions
Every request goes to https://api.uncart.ai over HTTPS. Bodies are JSON in UTF-8, and times are ISO 8601 in UTC.
The examples read your key from the UNCART_KEY environment variable. That keeps it out of your shell history and out of files you commit.