Alloy API
Live API documentation​
We automatically generate API documentation that's OpenAPI compliant and accessible via a web browser, making it easy for backend implementation and client-side consumption.
The following articles in this guide describe how to perform key tasks using our APIs and the Alloy database.
For comprehensive API documentation, please refer to the Swagger and ReDoc websites for your region:
| Region | URL | Swagger | ReDoc |
|---|---|---|---|
| United Kingdom | api.uk.alloyapp.io | Click here | Click here |
| Australia | api.au.alloyapp.io | Click here | Click here |
| Staging (latest pre-release) | api.staging.alloyapp.io | Click here | Click here |
For simplicity, the articles in this guide refer exclusively to the United Kingdom region. If you're working with a different region, please substitute accordingly.
Note
All API requests must be made over HTTPS. API requests made over plain HTTP or without authentication will fail.