Booster Codes API

The Booster Codes API feature enables the automatic distribution of booster codes through API requests.

Getting Started

To use this feature, please follow the steps below:

  1. Create a Tournament game with Booster Codes enabled.

  2. Navigate to the Tournament Details page, open the Published Links tab, and find Game ID (you will need it later to enable automatic distribution of booster codes through API requests).

  1. Then, open the Integration tab and click the Setup button in the Booster Codes API section.

  1. Copy the secret key* provided in the popup, and use the detailed instructions in our Help Center.

*Please note that the secret key automatically updates when a game is published or republished. You can also manually reset the secret key at any time. Once reset, a new secret key will be generated and assigned to the game, making the previous key invalid.

Developer Guide

API host

Retrieve Game Secret Key

Returns the current game secret key for external integrations.

Set New Game Secret Key

A new secret key is generated and assigned to the game, and an old key becomes invalid.

Requests for external integration

Check the number of boosters left

This request is recommended to make sure that there are available boosters in the tournament.

If no boosters are left, it will be impossible to claim a booster code.

Parameters:

gameId (string) — Game ID

Headers:

X-Api-Key (string) — Game secret key, used for authorization (can be retrieved from the Game details in the Games Admin Panel)

Responses:

Claim booster

It is used to receive a booster code.

This booster code should be passed to the user in any appropriate way:

  • sent by email,

  • printed on a receipt, etc.

Body: empty object or null

Parameters: gameId (string) — Game ID

Headers: X-Api-Key (string) — Game secret key, used for authorization (can be retrieved from the Game details in the Games Admin Panel)

Responses:

HTTP 200 { code: string, boostMultiplier: number }

  • code - a code string, that should be used to play tournament game.

  • boostMultiplier - a multiplier that will be applied to the player’s points after the game played with a booster.

Last updated

Was this helpful?