The spec, the explorer and Postman

A machine-readable description of every endpoint, a page that calls them, and a collection you can import.

The spec

Every endpoint, every parameter and every error is described in an OpenAPI 3.1 document at /docs/api/openapi.json. It is generated from the same list of routes the API itself serves, so it cannot drift: a route that exists and is missing from the spec fails our tests before it reaches you.

Most tools that talk to APIs will read it. Client generators, contract testers, and the import step of most integration platforms all take an OpenAPI URL.

The explorer

At /docs/api/explore there is a page listing every endpoint with the scope it needs. Paste a token into the box at the top and the read-only endpoints become callable, showing the real response from your own account.

The token stays in that browser tab. It is sent to the endpoint you choose to call and nowhere else, and it is not saved. Nothing on that page is loaded from anybody else's server.

Postman

A ready-made collection is at /docs/api/postman.json. Import it by URL rather than by download and Postman will pick up changes when we make them.

1. In Postman, choose Import, then Link.
2. Paste https://lynkarr.com/docs/api/postman.json and import.
3. Open the collection's Variables tab and put your token in `token`.
4. Every request in the collection sends it as a bearer token.