Skip to main content

Bruno request collection

Bruno is an open-source API client (a Postman alternative) for exploring and testing REST APIs. A pre-built Talo collection is available so you can try every endpoint.

Interactive explorer

Open the API explorer in a new tab

Install Bruno

Bruno is a desktop app available for macOS, Windows and Linux:

Import the Talo collection

  1. Open Bruno and click Import Collection.
  2. Paste the repository URL: https://github.com/TaloDev/bruno-collection.git
  3. Choose a location to save the collection locally.
  4. Click Clone.

The full collection is available in this repository.

Configure the environment

The collection ships with a Prod environment that has two variables:

VariableDescription
baseUrlThe API root. Defaults to https://api.trytalo.com - change this to point at a self-hosted instance.
apiKeyAn access key from the Talo dashboard.
warning

Requests will return 401 Unauthorized until you set apiKey.

To edit the environment in Bruno: click the environment name (Prod) in the top-right, then click Configure.

Acting on behalf of a player

Most player-scoped endpoints expect two headers in addition to the API key:

  1. x-talo-player - the player's ID
  2. x-talo-alias - the ID of one of the player's identified alias

To get these, run the Identify endpoint first (found in the Players folder of the collection). This will automatically set the variables for both of those headers.

Talo player authentication

If your game uses Talo's player authentication, you'll also need the x-talo-session header.

Run the register and login requests (from the Player auth folder). This will set the x-talo-session variable and refresh token variable (for refreshing the short-lived session token).

See Player authentication for the full flow.