curl -X POST \
  'https://{YOUR_INITIATE_GAME_AUTH_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "device": "MOBILE",
    "date": "2023-11-07T05:31:56Z"
  }'

{
  "deepLink": "https://my-awesome-game/2298/bv45d674?key=549bc5151667f6216629efe46vf7bacd2812d82298",
  "accessToken": "9ac8883227afa33412197b",
  "desktopAutoRedirect": false
}

Player Authentication

Initiate Game Auth Callback

Warning: This API endpoint is only relevant for the Game Redirect Login method.

Note: This is a callback API. Appcharge calls this endpoint on your server when specific events occur. Notifies your system to initiate an authentication session in your game.

Appcharge calls this endpoint when a player attempts to log in via Game Redirect Login. Your server responds with either the data needed to redirect the player to your game for authentication, or an error.

POST

{YOUR_INITIATE_GAME_AUTH_ENDPOINT}

curl -X POST \
  'https://{YOUR_INITIATE_GAME_AUTH_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "device": "MOBILE",
    "date": "2023-11-07T05:31:56Z"
  }'

{
  "deepLink": "https://my-awesome-game/2298/bv45d674?key=549bc5151667f6216629efe46vf7bacd2812d82298",
  "accessToken": "9ac8883227afa33412197b",
  "desktopAutoRedirect": false
}

curl -X POST \
  'https://{YOUR_INITIATE_GAME_AUTH_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "device": "MOBILE",
    "date": "2023-11-07T05:31:56Z"
  }'

{
  "deepLink": "https://my-awesome-game/2298/bv45d674?key=549bc5151667f6216629efe46vf7bacd2812d82298",
  "accessToken": "9ac8883227afa33412197b",
  "desktopAutoRedirect": false
}

Headers

x-publisher-token

string

Publisher token.

signature

string

The signed payload.

Body

application/json

device

enum<string>

Device the player used to log in.

DESKTOP: PCs and laptops.
APPCHARGE: Mobile.

Available options:

DESKTOP,

APPCHARGE

Example:

"DESKTOP"

date

string<date-time>

Date in ISO 8601 format.

Example:

"2023-11-07T05:31:56Z"

Response

deepLink

string

required

Deeplink for redirecting the player to your game for authentication.

Example:

"https://my-awesome-game/2298/bv45d674?key=549bc5151667f6216629efe46vf7bacd2812d82298"

accessToken

string

required

Player access token.

Example:

"9ac8883227afa33412197b"

desktopAutoRedirect

boolean

default:false

Whether players logging into the web store on desktop are redirected to the deepLink URL instead of being shown a QR code.

When false or omitted, these players see a QR code of the deeplink and must scan it with their phone to open the game.

Example:

true

Authenticate Player Callback Introduction

⌘I