API Reference
Technical reference for the Store's Rest API.
Authentication
All routes require authentication via an API key. Include the API key in the Authorization header of your requests as Bearer, like Authorization: Bearer <your key>. The API key can be generated within the admin dashboard of your store.
Abilities
Every token is issued with a set of abilities, chosen when the token is created. A request to an endpoint the token was not granted is rejected with 403, even though the token itself is valid.
| Ability | Grants |
|---|---|
* | Every ability, including any added in future versions. |
products:read | Product listings, versions, benefits and reviews. |
updates:post | Publishing a new version of a product or of one of its benefits, nothing else. |
users:read | User profiles, including lookups by username, email and Discord ID. |
licenses:read | Licenses belonging to a user. |
purchases:read | Purchase history. |
The health check accepts any valid token and needs no particular ability.
Choose a route in the sidebar to browse.