Overview
A Peritus game is a self-contained frame you embed. You identify the player; the game does the rest and hands back a scored, replayable result.
What you embed
One iframe holds an entire game: the lobby, play, match history, results and replays. The lobby shows your players the tier ladder they can enter, with practice available alongside it — the tier cards appear when your handshake declares you are seating paid matches. There is no board component to wrap and no game state for you to keep; it loads from our origin, so an update reaches your players without you shipping anything.
The four moving parts
- Your backend holds the API key. Four endpoints run an integration: mint a session, read the tier ladder, seat a player into a match, and read match results. The first alone reaches practice; a match needs the other three.
- Your page embeds the frame and exchanges a small, fixed set of messages with it. It never sees the API key.
- The game frame plays the match, talks to our servers directly, and reports progress to your page.
- The partner portal is where your team creates keys, registers the origins allowed to embed you, licenses games, and reads your usage.
What crosses the boundary
- Into the game: a short-lived session token identifying one player, scoped to one game — and, if sent, the name their opponent sees. Nothing else about them reaches us.
- Out of the game: the authoritative result, read by your backend from the results feed. Nothing the browser reports is part of it.
- Never: your users' credentials, your player balances, or any money at all.
Reading these docs from a tool
Every page under /docs is also published as markdown — /docs/results.md beside /docs/results, and so on — with /llms.txt as the index.
The contract and its changelog are published too — the contract and its changelog. They are the same files, verbatim.
Where to go next
- Quickstart — a working embed, end to end, with real hosts and copyable calls.
- Keys and environments — what a key looks like, and how test and live stay apart.
- Match results — the authoritative outcome of every match, and the only signal you may move money on.
- Errors and limits — every coded refusal, what causes it, and what to do about it.