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.
Onboard new unsecured games:
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.
During the configuration, select the
Is unsecured gameoption asYesAdd 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.
Request Access:
The game developer needs to request access to our game integration team to utilize this API.
Once the game is configured, go to the API client module in the CMS and generate/create API client secrets for the game
Retrieve the client id and provide this ID to the game developer to access these APIs.
API Documentation:
Start tournament API
API Endpoint:
https://backend.{TARGET_SERVER}.outplay.games/tournament-round/practise/{tournamentId}/start
API Endpoint Example:
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.
tournamentId (Required)
UUID of the Arcadia tournament
param
playerId (Required)
UUID of the unique Arcadia players
body - string
clientId (Required)
Game client ID - This is required for the authentication purposes
body - string
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 (Optional but necessary to track user IP)
Pass the player’s IP address while starting the tournament gameplay
header
End Tournament API
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.
tournamentId (Required)
UUID of the Arcadia tournament
param
playerId (Required)
UUID of the unique Arcadia players
body - string
clientId (Required)
Game client ID - This is required for the authentication purposes
body - string
score (Required)
Player’s tournament gameplay score
body - number
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
POSTMAN EXAMPLE
Here below is an example on how to call the API from PostMan so that you can test the server working before integrating into the game itself. The API accepts JSON objects as param, so the info requested need to be passed as JSON {} Please note that the keys will be old and you will need to request to OP team a new sets of
Last updated
