Unsecured Game API
Initially to onboard the unsecured games, please request the OP games team to add your game build into our servers and configure the game to become a tournament-ready game.
- 1.Once the game is uploaded to colyseus server, Configure the game via CMS with necessary details such as developer details, game details, and game URL.
- 2.During the configuration, select the
Is unsecured game
option asYes
- 3.Add the game into our smart contract to make it tournament ready.
Unsecured games are always free and they don’t allow anyone to create/host a paid tournament.
- 1.The game developer needs to request access to our game integration team to utilize this API.
- 2.Once the game is configured, go to the API client module in the CMS and generate/create API client secrets for the game
- 3.Retrieve the client id and provide this ID to the game developer to access these APIs.
API Endpoint:
https://backend.{TARGET_SERVER}.outplay.games/tournament-round/practise/{tournamentId}/start
Description:
This API is being used for starting the tournament gameplay in the Arcadia platform by calling the API from the game.
Payload Description:
TARGET_SERVER - This indicates the server URL and points to a respective target server such as
dev, stage, prod
.Payload | Description | Payload type |
---|---|---|
tournamentId (Required) | UUID of the Arcadia tournament | param |
playerId (Required) | UUID of the unique Arcadia players | body |
clientId (Required) | Game client ID - This is required for the authentication purposes | body |
walletAddress (Optional) | Players wallet address - It can be used to validate the current player’s wallet address against player’s info in our server. | body |
x-arcadia-player-ip (Required) | Pass the player’s IP address while starting the tournament gameplay | header |
API Endpoint:
https://backend.{TARGET_SERVER}.outplay.games/tournament-round/practise/{tournamentId}/end
Payload Description:
TARGET_SERVER - This indicates the server URL and points to a respective target server such as
dev, stage, prod
.
Payload | Description | Payload type |
---|---|---|
tournamentId (Required) | UUID of the Arcadia tournament | param |
playerId (Required) | UUID of the unique Arcadia players | body |
clientId (Required) | Game client ID - This is required for the authentication purposes | body |
score (Required) | Player’s tournament gameplay score | body |
otherPlayerScores (Optional) | It is an array of objects which represents the other player’s score which will be posted along with current player’s score
[{walletId: string, score: number}] | body |