Getting started
Getting started
Everything you need before your first integration call: keys, authentication, and the conventions every Tanitar API shares.
Tanitar provides Identity, Game, Gamification, Notification, Reward, Tenant and Tournament APIs that your back end calls with an API key. Every API handles authentication, authorization, rate limiting, idempotency and errors the same way, so once you understand these conventions you can apply them everywhere.
Start here
- Follow the quickstart: create an API key in the dashboard, make your first call, and register a webhook endpoint.
- Choose the scopes your integration needs from API keys and scopes.
- Read authentication to see which credential each route family expects and where each API is served.
Conventions every API shares
| Topic | What to know |
|---|---|
| Idempotency | Send an Idempotency-Key header on mutations. A retry with the same key and request returns the stored outcome. |
| Rate limits | Limits come from your plan, per rate class (read, mutation) and per API key. A 429 carries no Retry-After header. |
| Errors | Every error uses one envelope with a responseType category and, where the failure is typed, a stable errorCode. |
| Pagination | Lists page by cursor or by page number; some lists return everything at once. |