Skip to main content
POST
/
authenticate-player-endpoint
Authenticate Player
curl --request POST \
  --url https://{publisher-server.com}/authenticate-player-endpoint \
  --header 'Content-Type: application/json' \
  --header 'signature: <signature>' \
  --header 'x-publisher-token: <x-publisher-token>' \
  --data '{
  "authMethod": "facebook",
  "token": "sdfddtt7",
  "date": "2024-07-21T14:17:27.329Z",
  "appId": "611392880818819",
  "userName": "expertgamer1979",
  "password": "732hf8820pk!",
  "otp": {
    "playerCode": "974018",
    "accessToken": "9ac888fa33412197b"
  },
  "os": "android",
  "utmSource": "Facebook",
  "utmMedium": "email",
  "utmCampaign": "spring_sale.",
  "sessionId": "2e55b3fc-31ef-6dd7-8161-8aeb376b3a23",
  "playerLocation": {
    "countryCode2": "US",
    "state": "NY"
  }
}'
{
  "status": "valid",
  "playerProfileImage": "https://scontent-iad4-1.xx.fbcdn.net/v/t6.30597-1/84628273_176159830277856_972693363922829312_n.jpg?stp=c379.0.1290.1290a_cp0_dst-jpg_s50x50_tt6&ccb=1-7",
  "publisherPlayerId": "vip2247691",
  "playerName": "Jim Cardashian",
  "sessionMetadata": {
    "abTest": "group1",
    "locale": "en-US"
  }
}

Headers

​
x-publisher-token
string
required

Publisher token.

​
signature
string
required

The signed payload.

Body

application/json
​
authMethod
enum<string>
required

Authentication method the player used.

Available options:
facebook,
apple,
google,
userToken,
userPassword,
otp
Example:

"facebook"

​
token
string | null
required

Authentication token. Used for SSO Login and Player ID Login.

Example:

"sdfddtt7"

​
date
string<date-time>
required

UTC time when the player tried to log in.

Example:

"2024-07-21T14:17:27.329Z"

​
appId
string
required

App ID in the Publisher Dashboard. Used for the SSO Login method. If no app ID is available, Appcharge sends "NA".

Example:

"611392880818819"

​
playerLocation
object
required

Location of the player.

​
userName
string | null

Username the player entered when logging in to the web store.

Example:

"expertgamer1979"

​
password
string | null

Password the player entered when logging in to the web store.

Example:

"732hf8820pk!"

​
otp
object | null

Additional authentication tokens sent by your game. Used for Pre-Authenticated Login and Game Redirect Login methods.

​
os
enum<string>

Operating system the player used to log in.

Available options:
ios,
android,
web
Example:

"android"

​
utmSource
string

Source of the traffic. This is where the player came from before reaching the store.

Example:

"Facebook"

​
utmMedium
string

Marketing channel used to bring in the traffic.

Example:

"email"

​
utmCampaign
string

Marketing campaign identifier associated with the traffic.

Example:

"spring_sale."

​
sessionId
string

Session ID.

Example:

"2e55b3fc-31ef-6dd7-8161-8aeb376b3a23"

Response

Login successful.

​
status
enum<string>

The status of the player authentication. If you pass a value other than valid, the API fails.

Available options:
valid
Example:

"valid"

​
playerProfileImage
string

Player profile image. If no image is available, an empty string must be provided. A default image will be displayed in this case.

Example:

"https://scontent-iad4-1.xx.fbcdn.net/v/t6.30597-1/84628273_176159830277856_972693363922829312_n.jpg?stp=c379.0.1290.1290a_cp0_dst-jpg_s50x50_tt6&ccb=1-7"

​
publisherPlayerId
string

Player ID.

Example:

"vip2247691"

​
playerName
string

Player name.

Example:

"Jim Cardashian"

​
sessionMetadata
object

An object for passing data related to the player's session. It will be returned in the Grant Award Callback, and if enabled, the Personalization API.

Example:
{ "abTest": "group1", "locale": "en-US" }
⌘I