Issue a match session

Opens a single match context for an authenticated player. This is the start gate: a session is only issued when

• the game is published,
• the x-game-key credential is valid for the requested environment and origin,
• the credential has the session scope, and
• the player is a real participant of the match.

The returned token is single-use, expires after 10 minutes, and is consumed when the player submits a result. boardHash is a number/integer match id.

POST /api/v1/game-sdk/{gameId}/sessions

Issue a match session

cURL

curl --request POST \
  --url https://api.musterbox.com/api/v1/game-sdk/{gameId}/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "matchId": 1042
}
'

200

{
  "sessionId": "<string>",
  "token": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "context": {
    "tournamentId": "tor-8f21c3",
    "matchId": 123,
    "participantId": 123,
    "slot": 1
  }
}

Authorizations

bearerAuthgameKey

Authorization · string · header · required

Player access token returned by login/refresh.

Path Parameters

gameId · string · required

The identifier of the game (as registered in the MusterBox console).

Body

application/json

environment · enum<string> · required

Backend environment the credential was created for.

Available options: local, sandbox, staging, production

matchId · integer · required

The bracket Match this player belongs to.

Example:

1042

Response

200

application/json

A fresh, single-use match session and its participant context.

sessionId · string · required

Backend id of the issued session.

token · string · required

Single-use session token for /game-sdk/{gameId}/results.

expiresAt · string<date-time> · required

Session expiry (10-minute TTL).

context · object · required

Show child attributes