Guides
Task-oriented guides to each Tanitar capability you can drive from your own back-end with an API key.
The guides walk through each capability of your Tanitar tenant in the order you would build on it.
Every route they document is on the public /v1 plane (or, for tournaments and recovery, the
unversioned paths those services mount) and is called by your back-end with an API key that carries
the scopes the guide names. What your players do is described alongside, as "what your players see";
the player plane itself is covered in Player identity.
Before you start, make sure you have an API key with the right scopes (API keys and scopes) and know how idempotency, rate limits and errors work: every guide relies on them.
Competitions and engagement
Tournaments
Create, publish and run brackets: enrollment, check-in, results, evidence and placements.
Gamification
Author missions, ingest your game events, read progress, run seasons, chests and leaderboards.
Membership tiers
Define the tiers your players belong to and publish the default tier.
Economy
Rewards
Your currencies, wallets, grants, award kinds, exchanges and prize payouts.
Shop
Sell listings priced in your currencies: catalog, stock, orders, fulfilment and reversal.
Web3 verification
Check which chains your tenant can use and verify the contracts behind them.
Operations
How the guides are organised
Each guide follows the same pattern:
- The model: the records involved and the states they move through.
- The routes: method, path, required scope, and whether an
Idempotency-Keyis required. - Worked requests:
curlsamples against a base URL placeholder such as$REWARD_API_URL. - Refusals: the stable
errorCodevalues you should handle. - Events: the webhook events the capability publishes, linking to the event catalog.
The Dashboard section covers configuration that only the dashboard can change, including webhooks, payout accounts and customer Web3 configuration.