Check a join token

POST

/v1/servers/{id}/join/verify

curl --request POST \
  --url https://api.gampeon.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/join/verify \
  --header 'Content-Type: application/json' \
  --header 'x-server-key: <x-server-key>' \
  --data '{ "token": "example" }'

• Production

Called by the game server when a player connects with a join token. Answers who the player is and uses the token up. Unknown, expired, used tokens and tokens for another server are refused alike.

Rate limit: 1200 per minute per server.

Authorizations

• serverKey

Parameters

Path Parameters

id

required

string format: uuid

Server ID

Header Parameters

x-server-key

required

string

Key from registering the server

Request Body^required

Media typeapplication/json

object

token

required

Join token from the client

string

/^[A-Za-z0-9_-]{43}$/

Example ^generated

{
  "token": "example"
}

Responses

200

Player

Media typeapplication/json

object

account

required

object

id

required

Account ID. Stable, use it to keep the player’s progress.

integer

handle

required

Handle, can change

string

displayName

required

string

avatar

required

One of:

string

Path of the profile picture, relative to the API

string

null

null

issuedAt

required

When the launcher asked for the token

integer format: int64

Example ^generated

{
  "account": {
    "id": 1,
    "handle": "example",
    "displayName": "example",
    "avatar": "example"
  },
  "issuedAt": 1
}

400

Error codes: invalid_field, invalid_join_token

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: invalid_server_key

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 1200 per minute per server. Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}