Player Accounts

The ChilliConnect Player Accounts module. Provides the means to create new players, log in to existing accounts and modify account data.

Create Player

It is no longer recommended to create new players through this endpoint. It is better to create new players by using any of the other Login endpoints that have a CreatePlayer property. Creates a new, anonymous ChilliConnect player account for a specific game. UserName, DisplayName, Email and Password details can be provided but are not required. Will return a ChilliConnectID and ChilliConnectSecret that uniquely identifies the newly created player. These details can be used to login to the players account via the LogInUsingChilliConnect method.

/1.0/player/create

Header

Field	Type	Description
Game-Token	String	The Game within which to create the new player.

Parameter

Field	Type	Description
UserName optional	String	The UserName of the new player account. If provided, this must be unique across all players within the game, contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
DisplayName optional	String	A non-unique DisplayName that can be used to identify the Player within the game. If provided it can contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
Email optional	String	Email address to be associated with the new player account. If provided, this must be unique across all players within the game.
Password optional	String	Password to be assigned to the new player account. If provided must be greater than 6 and less than 50 characters in length.
Country optional	String	Country of the player. Must be two letter country code ISO 3166-1 alpha-2. E.g. `GB`. If not provided, will be automatically populated.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The `ChilliConnectID` of the account.
ChilliConnectSecret	String	The `ChilliConnectSecret` of the account.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2006	UserName Taken. The supplied `UserName` has already taken by another player within this game.
2007	Email Taken. The supplied `Email` address has already taken by another player within this game.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "ChilliConnectID"   	: "284LD4sAB5Ygo2RSl8h4vVW48qAbA8Cr",
 "ChilliConnectSecret" 	: "1cIVAEwPRP1czuPkqUEIQmXxwDfIVkGI"
}

Create Player

Request

CCCreatePlayerRequest
Property	Type	Description
UserName optional	NSString	The UserName of the new player account. If provided, this must be unique across all players within the game, contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
DisplayName optional	NSString	A non-unique DisplayName that can be used to identify the Player within the game. If provided it can contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
Email optional	NSString	Email address to be associated with the new player account. If provided, this must be unique across all players within the game.
Password optional	NSString	Password to be assigned to the new player account. If provided must be greater than 6 and less than 50 characters in length.
Country optional	NSString	Country of the player. Must be two letter country code ISO 3166-1 alpha-2. E.g. `GB`. If not provided, will be automatically populated.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCCreatePlayerResponse
Property	Type	Description
ChilliConnectID	NSString	The `ChilliConnectID` of the account.
ChilliConnectSecret	NSString	The `ChilliConnectSecret` of the account.

Errors

CCCreatePlayerError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
EmailTaken	Email Taken. The supplied `Email` address has already taken by another player within this game.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.
UserNameTaken	UserName Taken. The supplied `UserName` has already taken by another player within this game.

Examples

Create Player

CCPlayerAccounts *playerAccounts = chilliConnect.playerAccounts;

CCCreatePlayerResponseCallback successCallback = ^(CCCreatePlayerRequest *request, CCCreatePlayerResponse *response) {
    self.chilliConnectId = response.chilliConnectId;
    self.chilliConnectSecret = response.chilliConnectSecret;
    NSLog(@"Player created with ChilliConnectId: %@", self.chilliConnectId);
};

CCCreatePlayerErrorCallback errorCallback = ^(CCCreatePlayerRequest *request, CCCreatePlayerError *error) {
    NSLog(@"An error occurred while creating a new player: %@", error.errorDescription);
};

CCCreatePlayerRequestDesc *requestDesc = [CCCreatePlayerRequestDesc createPlayerRequestDesc];
requestDesc.displayName = @"TestPlayer";

[playerAccounts createPlayerWithDesc:requestDesc successCallback:successCallback errorCallback:errorCallback];

Create Player

Request

CreatePlayerRequest
Property	Type	Description
UserName optional	string	The UserName of the new player account. If provided, this must be unique across all players within the game, contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
DisplayName optional	string	A non-unique DisplayName that can be used to identify the Player within the game. If provided it can contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
Email optional	string	Email address to be associated with the new player account. If provided, this must be unique across all players within the game.
Password optional	string	Password to be assigned to the new player account. If provided must be greater than 6 and less than 50 characters in length.
Country optional	string	Country of the player. Must be two letter country code ISO 3166-1 alpha-2. E.g. `GB`. If not provided, will be automatically populated.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

CreatePlayerResponse
Property	Type	Description
ChilliConnectID	string	The `ChilliConnectID` of the account.
ChilliConnectSecret	string	The `ChilliConnectSecret` of the account.

Errors

CreatePlayerError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
EmailTaken	Email Taken. The supplied `Email` address has already taken by another player within this game.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.
UserNameTaken	UserName Taken. The supplied `UserName` has already taken by another player within this game.

Examples

Create Player

var playerAccounts = chilliConnect.PlayerAccounts;

Action<CreatePlayerRequest, CreatePlayerResponse> successCallback = (CreatePlayerRequest request, CreatePlayerResponse response) =>
{
    ChilliConnectId = response.ChilliConnectId;
    ChilliConnectSecret = response.ChilliConnectSecret;
    
    UnityEngine.Debug.Log("Player created with ChilliConnectId: " + ChilliConnectId);
};

Action<CreatePlayerRequest, CreatePlayerError> errorCallback = (CreatePlayerRequest request, CreatePlayerError error) =>
{
    UnityEngine.Debug.Log("An error occurred while creating a new player: " + error.ErrorDescription);
};

var requestDesc = new CreatePlayerRequestDesc();
requestDesc.DisplayName = "TestPlayer";

playerAccounts.CreatePlayer(requestDesc, successCallback, errorCallback);

Create Player

Node

PlayerAccounts \| Create Player
Property	Type	Description
Optionals optional	CCCreatePlayerRequestOptionalsDesc	Optional properties for this request.

CCCreatePlayerRequestOptionalsDesc
Property	Type	Description
UserName optional	FString	The UserName of the new player account. If provided, this must be unique across all players within the game, contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
DisplayName optional	FString	A non-unique DisplayName that can be used to identify the Player within the game. If provided it can contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
Email optional	FString	Email address to be associated with the new player account. If provided, this must be unique across all players within the game.
Password optional	FString	Password to be assigned to the new player account. If provided must be greater than 6 and less than 50 characters in length.
Country optional	FString	Country of the player. Must be two letter country code ISO 3166-1 alpha-2. E.g. `GB`. If not provided, will be automatically populated.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCCreatePlayerResponse
Property	Type	Description
ChilliConnectID	FString	The `ChilliConnectID` of the account.
ChilliConnectSecret	FString	The `ChilliConnectSecret` of the account.

Errors

CCCreatePlayerError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
EmailTaken	2007	Email Taken. The supplied `Email` address has already taken by another player within this game.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.
UserNameTaken	2006	UserName Taken. The supplied `UserName` has already taken by another player within this game.

Create Player

Request

sdk.PlayerAccounts.createPlayer( `UserName` `DisplayName` `Email` `Password` `Country` `DeviceModel` `DeviceType` `Platform` `AppVersion` )
Parameter	Type	Description
UserName optional	String	The UserName of the new player account. If provided, this must be unique across all players within the game, contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
DisplayName optional	String	A non-unique DisplayName that can be used to identify the Player within the game. If provided it can contain only alpha, numeric, underscore or dash characters, and a minimum size of 3 characters, maximum 50.
Email optional	String	Email address to be associated with the new player account. If provided, this must be unique across all players within the game.
Password optional	String	Password to be assigned to the new player account. If provided must be greater than 6 and less than 50 characters in length.
Country optional	String	Country of the player. Must be two letter country code ISO 3166-1 alpha-2. E.g. `GB`. If not provided, will be automatically populated.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	String	The client version of your game.

Response

Attribute	Type	Description
ChilliConnectID	String	The `ChilliConnectID` of the account.
ChilliConnectSecret	String	The `ChilliConnectSecret` of the account.

Exceptions

Code	Name	Description
1007	InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
1008	TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
1013	TrialExpired	Trial Expired. Trial Period Expired
2006	UserNameTaken	UserName Taken. The supplied `UserName` has already taken by another player within this game.
2007	EmailTaken	Email Taken. The supplied `Email` address has already taken by another player within this game.
10003	AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Request Password Reset

Request a password reset email to be sent to the provided email address.

/1.0/player/password/reset

Header

Field	Type	Description
Game-Token	String	The Game within which to request the password reset.

Parameter

Field	Type	Description
Email	String	The Email address of account.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Request Password Reset

Request a password reset email to be sent to the provided email address.

Request

CCRequestPasswordResetRequest
Property	Type	Description
Email	NSString	The Email address of account.

Errors

CCRequestPasswordResetError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Request Password Reset

Request a password reset email to be sent to the provided email address.

Request

RequestPasswordResetRequest
Property	Type	Description
Email	string	The Email address of account.

Errors

RequestPasswordResetError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Request Password Reset

Request a password reset email to be sent to the provided email address.

Node

PlayerAccounts \| Request Password Reset
Property	Type	Description
Email	FString	The Email address of account.

Errors

CCRequestPasswordResetError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Request Password Reset

Request a password reset email to be sent to the provided email address.

Request

sdk.PlayerAccounts.requestPasswordReset( `Email` )
Parameter	Type	Description
Email	String	The Email address of account.

Exceptions

Code	Name	Description
1007	InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
1008	TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
1013	TrialExpired	Trial Expired. Trial Period Expired
10003	AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Log In Using Mobile Device Id

Login to the system using a Mobile DeviceId and Platform. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/1.0/player/login/device

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
DeviceID	String	DeviceId is provided by iOS system on calling the Social system.
Platform	String	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this DeviceId and Platform.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Mobile Device Id

Request

CCLogInUsingMobileDeviceIdRequest
Property	Type	Description
DeviceID	NSString	DeviceId is provided by iOS system on calling the Social system.
Platform	NSString	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this DeviceId and Platform.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingMobileDeviceIdResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Mobile Device Id

Request

LogInUsingMobileDeviceIdRequest
Property	Type	Description
DeviceID	string	DeviceId is provided by iOS system on calling the Social system.
Platform	string	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this DeviceId and Platform.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingMobileDeviceIdResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Mobile Device Id

Node

PlayerAccounts \| Log In Using Mobile Device Id
Property	Type	Description
DeviceID	FString	DeviceId is provided by iOS system on calling the Social system.
Platform	FString	Platform of the device being used by the player. Accepted values: `ANDROID`, `IOS`, `KINDLE`.
Optionals optional	CCLogInUsingMobileDeviceIdRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingMobileDeviceIdRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this DeviceId and Platform.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingMobileDeviceIdResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingMobileDeviceIdError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Mobile Device Id

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Chilli Connect

Login to the system using a ChilliConnectID and a ChilliConnectSecret. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests.

/2.0/player/login/chilli

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
ChilliConnectSecret	String	The player's `ChilliConnectSecret`.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ConnectAccessToken	String	A time limited `ConnectAccessToken` that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.
CatalogVersion	String	The Catalog Version.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "ConnectAccessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzODY4OTkxMzEsImlzcyI6ImppcmE6MTU0ODk1OTUiLCJxc2giOiI4MDYzZmY0Y2ExZTQxZGY3YmM5MGM4YWI2ZDBmNjIwN2Q0OTFjZjZkYWQ3YzY2ZWE3OTdiNDYxNGI3MTkyMmU5IiwiaWF0IjoxMzg2ODk4OTUxfQ.uKqU9dTB6gKwG6jQCuXYAiMNdfNRw98Hw_IWuA5MaMo",
 "MetricsAccessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uVG9rZW4iOiI0ZTJhM2NmYS02MjNjLTExZTctYTNlZC0wODAwMjc4Yjc4YTYiLCJ1c2VySWQiOiJWMWFISjBLTDFUdjZ2R1BKYWVaTVd2bVo1MDh0UktCTSIsImN3QXBwSWQiOiIyIn0.GHIuB7fV_yGgPY3nvjZ1LlLBr8sEDgisQg6gkRVMtkE",
 "CatalogVersion" : "e0200111daaa5839e6f310ce2d843189"
}

Log In Using Chilli Connect

Login to the system using a ChilliConnectID and a ChilliConnectSecret. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests.

Request

CCLogInUsingChilliConnectRequest
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
ChilliConnectSecret	NSString	The player's `ChilliConnectSecret`.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingChilliConnectResponse
Property	Type	Description
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingChilliConnectError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

CCPlayerAccounts *playerAccounts = chilliConnect.playerAccounts;

CCLogInUsingChilliConnectResponseCallback successCallback = ^(CCLogInUsingChilliConnectRequest *request, CCLogInUsingChilliConnectResponse *response) {
    NSLog(@"Successfully logged in!");
};

CCLogInUsingChilliConnectErrorCallback errorCallback = ^(CCLogInUsingChilliConnectRequest *request, CCLogInUsingChilliConnectError *error) {
    NSLog(@"An error occurred while logging in: %@", error.errorDescription);
};

CCLogInUsingChilliConnectRequestDesc *desc = [CCLogInUsingChilliConnectRequestDesc logInUsingChilliConnectRequestDescWithChilliConnectId:self.chilliConnectId chilliConnectSecret:self.chilliConnectSecret];
[playerAccounts logInUsingChilliConnect:desc successCallback:successCallback errorCallback:errorCallback];

Log In Using Chilli Connect

Login to the system using a ChilliConnectID and a ChilliConnectSecret. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests.

Request

LogInUsingChilliConnectRequest
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
ChilliConnectSecret	string	The player's `ChilliConnectSecret`.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingChilliConnectResponse
Property	Type	Description
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingChilliConnectError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

var playerAccounts = chilliConnect.PlayerAccounts;

Action<LogInUsingChilliConnectRequest, LogInUsingChilliConnectResponse> successCallback = (LogInUsingChilliConnectRequest request, LogInUsingChilliConnectResponse response) =>
{
    UnityEngine.Debug.Log("Successfully logged in!");
};

Action<LogInUsingChilliConnectRequest, LogInUsingChilliConnectError> errorCallback = (LogInUsingChilliConnectRequest request, LogInUsingChilliConnectError error) =>
{
    UnityEngine.Debug.Log("An error occurred while logging in: " + error.ErrorDescription);
};

var loginDesc = new LogInUsingChilliConnectRequestDesc(ChilliConnectId, ChilliConnectSecret);
playerAccounts.LogInUsingChilliConnect(loginDesc, successCallback, errorCallback);

Log In Using Chilli Connect

Login to the system using a ChilliConnectID and a ChilliConnectSecret. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests.

Node

PlayerAccounts \| Log In Using Chilli Connect
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
ChilliConnectSecret	FString	The player's `ChilliConnectSecret`.
Optionals optional	CCLogInUsingChilliConnectRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingChilliConnectRequestOptionalsDesc
Property	Type	Description
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingChilliConnectResponse
Property	Type	Description
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingChilliConnectError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Chilli Connect

Login to the system using a ChilliConnectID and a ChilliConnectSecret. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests.

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Email

Login to the system using an Email and Password. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/2.0/player/login/email

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
Email	String	The player's Email.
Password	String	The player's Password.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited `ConnectAccessToken` that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "ConnectAccessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzODY4OTkxMzEsImlzcyI6ImppcmE6MTU0ODk1OTUiLCJxc2giOiI4MDYzZmY0Y2ExZTQxZGY3YmM5MGM4YWI2ZDBmNjIwN2Q0OTFjZjZkYWQ3YzY2ZWE3OTdiNDYxNGI3MTkyMmU5IiwiaWF0IjoxMzg2ODk4OTUxfQ.uKqU9dTB6gKwG6jQCuXYAiMNdfNRw98Hw_IWuA5MaMo",
 "MetricsAccessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uVG9rZW4iOiI0ZTJhM2NmYS02MjNjLTExZTctYTNlZC0wODAwMjc4Yjc4YTYiLCJ1c2VySWQiOiJWMWFISjBLTDFUdjZ2R1BKYWVaTVd2bVo1MDh0UktCTSIsImN3QXBwSWQiOiIyIn0.GHIuB7fV_yGgPY3nvjZ1LlLBr8sEDgisQg6gkRVMtkE",
 "ChilliConnectID" : "284LD4sAB5Ygo2RSl8h4vVW48qAbA8Cr",
 "CatalogVersion" : "e0200111daaa5839e6f310ce2d843189"
}

Log In Using Email

Request

CCLogInUsingEmailRequest
Property	Type	Description
Email	NSString	The player's Email.
Password	NSString	The player's Password.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingEmailResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingEmailError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

CCPlayerAccounts *playerAccounts = CCPlayerAccounts.playerAccounts;

CCLogInUsingEmailResponseCallback successCallback = ^(CCLogInUsingEmailRequest *request, CCLogInUsingEmailResponse *response) {
    NSLog(@"Successfully logged in!");
};

CCLogInUsingEmailErrorCallback errorCallback = ^(CCLogInUsingEmailRequest *request, CCLogInUsingEmailError *error) {
    NSLog(@"An error occurred while logging in: %@", error.errorDescription);
};

CCLogInUsingEmailRequestDesc *desc = [CCLogInUsingEmailRequestDesc logInUsingEmailRequestDescWithEmail:@"email@example.com" password:@"Password"];
[playerAccounts logInUsingEmail:desc successCallback:successCallback errorCallback:errorCallback];

Log In Using Email

Request

LogInUsingEmailRequest
Property	Type	Description
Email	string	The player's Email.
Password	string	The player's Password.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingEmailResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingEmailError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

var playerAccounts = chilliConnect.PlayerAccounts;

Action<LogInUsingEmailRequest, LogInUsingEmailResponse> successCallback = (LogInUsingEmailRequest request, LogInUsingEmailResponse response) =>
{
    UnityEngine.Debug.Log("Successfully logged in!");
};

Action<LogInUsingEmailRequest, LogInUsingEmailError> errorCallback = (LogInUsingEmailRequest request, LogInUsingEmailError error) =>
{
    UnityEngine.Debug.Log("An error occurred while logging in: " + error.ErrorDescription);
};

var loginDesc = new LogInUsingEmailRequestDesc("email@example.com", "Password");
playerAccounts.LogInUsingEmail(loginDesc, successCallback, errorCallback);

Log In Using Email

Node

PlayerAccounts \| Log In Using Email
Property	Type	Description
Email	FString	The player's Email.
Password	FString	The player's Password.
Optionals optional	CCLogInUsingEmailRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingEmailRequestOptionalsDesc
Property	Type	Description
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingEmailResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingEmailError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Email

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Facebook

Login to the system using a FacebookAccessToken. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/2.0/player/login/facebook

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
FacebookAccessToken	String	Access Token provided from the Facebook API.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this Facebook Account.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.
FacebookID	String	The player's Facebook account ID.
FacebookName	String	The player's Facebook account name.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
2002	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "ConnectAccessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzODY4OTkxMzEsImlzcyI6ImppcmE6MTU0ODk1OTUiLCJxc2giOiI4MDYzZmY0Y2ExZTQxZGY3YmM5MGM4YWI2ZDBmNjIwN2Q0OTFjZjZkYWQ3YzY2ZWE3OTdiNDYxNGI3MTkyMmU5IiwiaWF0IjoxMzg2ODk4OTUxfQ.uKqU9dTB6gKwG6jQCuXYAiMNdfNRw98Hw_IWuA5MaMo",
 "MetricsAccessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uVG9rZW4iOiI0ZTJhM2NmYS02MjNjLTExZTctYTNlZC0wODAwMjc4Yjc4YTYiLCJ1c2VySWQiOiJWMWFISjBLTDFUdjZ2R1BKYWVaTVd2bVo1MDh0UktCTSIsImN3QXBwSWQiOiIyIn0.GHIuB7fV_yGgPY3nvjZ1LlLBr8sEDgisQg6gkRVMtkE",
 "ChilliConnectID" : "284LD4sAB5Ygo2RSl8h4vVW48qAbA8Cr",
 "CatalogVersion" : "e0200111daaa5839e6f310ce2d843189",
 "FacebookID" : "21231232132",
 "FacebookName" : "Mike Herron"
}

Log In Using Facebook

Request

CCLogInUsingFacebookRequest
Property	Type	Description
FacebookAccessToken	NSString	Access Token provided from the Facebook API.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this Facebook Account.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingFacebookResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.
FacebookID	NSString	The player's Facebook account ID.
FacebookName	NSString	The player's Facebook account name.

Errors

CCLogInUsingFacebookError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
FacebookAccessTokenInvalid	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

CCPlayerAccounts *playerAccounts = chilliConnect.playerAccounts;

CCLogInUsingFacebookResponseCallback successCallback = ^(CCLogInUsingFacebookRequest *request, CCLogInUsingFacebookResponse *response) {
    NSLog(@"Successfully logged in!");
};

CCLogInUsingFacebookErrorCallback errorCallback = ^(CCLogInUsingFacebookRequest *request, CCLogInUsingFacebookError *error) {
    NSLog(@"An error occurred while logging in: %@", error.errorDescription);
};

CCLogInUsingFacebookRequestDesc *desc = [CCLogInUsingFacebookRequestDesc logInUsingFacebookRequestDescWithFacebookAccessToken:facebookAccessToken];
[playerAccounts logInUsingFacebook:desc successCallback:successCallback errorCallback:errorCallback];

Log In Using Facebook

Request

LogInUsingFacebookRequest
Property	Type	Description
FacebookAccessToken	string	Access Token provided from the Facebook API.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Facebook Account.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingFacebookResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.
FacebookID	string	The player's Facebook account ID.
FacebookName	string	The player's Facebook account name.

Errors

LogInUsingFacebookError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
FacebookAccessTokenInvalid	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

var playerAccounts = chilliConnect.PlayerAccounts;

Action<LogInUsingFacebookRequest, LogInUsingFacebookResponse> successCallback = (LogInUsingFacebookRequest request, LogInUsingFacebookResponse response) =>
{
    UnityEngine.Debug.Log("Successfully logged in!");
};

Action<LogInUsingFacebookRequest, LogInUsingFacebookError> errorCallback = (LogInUsingFacebookRequest request, LogInUsingFacebookError error) =>
{
    UnityEngine.Debug.Log("An error occurred while logging in: " + error.ErrorDescription);
};

var loginDesc = new LogInUsingFacebookRequestDesc(facebookAccessToken);
playerAccounts.LogInUsingFacebook(loginDesc, successCallback, errorCallback);

Log In Using Facebook

Node

PlayerAccounts \| Log In Using Facebook
Property	Type	Description
FacebookAccessToken	FString	Access Token provided from the Facebook API.
Optionals optional	CCLogInUsingFacebookRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingFacebookRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Facebook Account.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingFacebookResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.
FacebookID	FString	The player's Facebook account ID.
FacebookName	FString	The player's Facebook account name.

Errors

CCLogInUsingFacebookError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
FacebookAccessTokenInvalid	2002	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Facebook

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Custom

/1.0/player/login/custom

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
LoginRequest	JSON	Generic payload of data for login.
Type	String	Custom login type - API Script name should match.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this custom login.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.
LoginResponse	JSON	Any data returned

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
1013	Trial Expired. Trial Period Expired
9003	Script Not Found. The specified script does not exist.

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
9002	Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Custom

Request

CCLogInUsingCustomRequest
Property	Type	Description
LoginRequest	SCMultiTypeValue	Generic payload of data for login.
Type	NSString	Custom login type - API Script name should match.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this custom login.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingCustomResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.
LoginResponse optional	SCMultiTypeValue	Any data returned

Errors

CCLogInUsingCustomError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
ScriptException	Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.
ScriptNotFound	Script Not Found. The specified script does not exist.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Custom

Request

LogInUsingCustomRequest
Property	Type	Description
LoginRequest	MultiTypeValue	Generic payload of data for login.
Type	string	Custom login type - API Script name should match.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this custom login.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingCustomResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.
LoginResponse optional	MultiTypeValue	Any data returned

Errors

LogInUsingCustomError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
ScriptException	Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.
ScriptNotFound	Script Not Found. The specified script does not exist.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Custom

Node

PlayerAccounts \| Log In Using Custom
Property	Type	Description
LoginRequest	CCMultiTypeValue	Generic payload of data for login.
Type	FString	Custom login type - API Script name should match.
Optionals optional	CCLogInUsingCustomRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingCustomRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this custom login.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingCustomResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.
LoginResponse optional	CCMultiTypeValue	Any data returned

Errors

CCLogInUsingCustomError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
ScriptException	9002	Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.
ScriptNotFound	9003	Script Not Found. The specified script does not exist.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Custom

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Google

Login to the system using a Google Auth Code. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/2.0/player/login/google

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
AuthCode	String	Authorisation Code provided by Google, obtainable on the Client through Google Play.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this Google Account.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
GoogleName	String	The player's full name from `Google Services`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2018	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
2019	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
2020	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
2021	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Google

Request

CCLogInUsingGoogleRequest
Property	Type	Description
AuthCode	NSString	Authorisation Code provided by Google, obtainable on the Client through Google Play.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this Google Account.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingGoogleResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
GoogleName	NSString	The player's full name from `Google Services`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingGoogleError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
NoGoogleOauthHasBeenConfiguredForApplication	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
SuppliedAuthCodeAlreadyRedeemed	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Google

Request

LogInUsingGoogleRequest
Property	Type	Description
AuthCode	string	Authorisation Code provided by Google, obtainable on the Client through Google Play.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Google Account.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingGoogleResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
GoogleName	string	The player's full name from `Google Services`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingGoogleError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
NoGoogleOauthHasBeenConfiguredForApplication	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
SuppliedAuthCodeAlreadyRedeemed	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Google

Node

PlayerAccounts \| Log In Using Google
Property	Type	Description
AuthCode	FString	Authorisation Code provided by Google, obtainable on the Client through Google Play.
Optionals optional	CCLogInUsingGoogleRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingGoogleRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Google Account.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingGoogleResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
GoogleName	FString	The player's full name from `Google Services`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingGoogleError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
NoGoogleOauthHasBeenConfiguredForApplication	2018	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
SuppliedAuthCodeAlreadyRedeemed	2019	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	2021	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	2020	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Google

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Game Center

Login to the system using a GameCenterID. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/2.0/player/login/gamecenter

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
GameCenterID	String	GameCenterID is provided by iOS system on calling the Social system.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this GameCenterId.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Game Center

Request

CCLogInUsingGameCenterRequest
Property	Type	Description
GameCenterID	NSString	GameCenterID is provided by iOS system on calling the Social system.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this GameCenterId.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingGameCenterResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingGameCenterError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Game Center

Request

LogInUsingGameCenterRequest
Property	Type	Description
GameCenterID	string	GameCenterID is provided by iOS system on calling the Social system.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this GameCenterId.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingGameCenterResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingGameCenterError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Game Center

Node

PlayerAccounts \| Log In Using Game Center
Property	Type	Description
GameCenterID	FString	GameCenterID is provided by iOS system on calling the Social system.
Optionals optional	CCLogInUsingGameCenterRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingGameCenterRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this GameCenterId.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingGameCenterResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingGameCenterError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
LoginNotFound	1006	Login Not Found. The supplied player credentials were valid, but could not find a ChilliConnect player that has been linked to the account.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Game Center

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Steam

Login to the system using a SessionTicket from the Steamworks Framework. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID and SteamID of the logged in player.

/1.0/player/login/steam

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
SessionTicket	String	Long Hex Code String supplied by the Steamworks Framework, used to verify that the Player is legitimate and belongs to configured Steam App.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this Steam Account.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
SteamID	String	The player's `SteamID` supplied by Steam Verification servers, is used as a confirmation that the Player is valid.
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2025	Supplied Steam Ticket Could Not Be Authenticated. The Supplied Steam Session Ticket could not be authenticated with Steamworks Servers.
2026	No Steam Details Configured For Project. Steam access details have not been entered into the Dashboard.
2031	Incorrect Steam AppID For Provided Session Ticket. The Session Ticket supplied by the user does not authenticate with the Steam App ID specified in Dashboard.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
2030	Steam Details Have Been Configured Incorrectly. Steam Authentication has returned an error code that signals an issue with the AppID and API Key configured in Dashboard.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Steam

Request

CCLogInUsingSteamRequest
Property	Type	Description
SessionTicket	NSString	Long Hex Code String supplied by the Steamworks Framework, used to verify that the Player is legitimate and belongs to configured Steam App.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this Steam Account.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingSteamResponse
Property	Type	Description
SteamID	NSString	The player's `SteamID` supplied by Steam Verification servers, is used as a confirmation that the Player is valid.
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingSteamError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
NoSteamAppDetailsHaveBeenConfigured	No Steam Details Configured For Project. Steam access details have not been entered into the Dashboard.
SteamAppDetailsConfiguredIncorrectly	Steam Details Have Been Configured Incorrectly. Steam Authentication has returned an error code that signals an issue with the AppID and API Key configured in Dashboard.
SteamAppIdIncompatibleWithSessionTicket	Incorrect Steam AppID For Provided Session Ticket. The Session Ticket supplied by the user does not authenticate with the Steam App ID specified in Dashboard.
SuppliedSteamTicketIsInvalid	Supplied Steam Ticket Could Not Be Authenticated. The Supplied Steam Session Ticket could not be authenticated with Steamworks Servers.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Steam

Request

LogInUsingSteamRequest
Property	Type	Description
SessionTicket	string	Long Hex Code String supplied by the Steamworks Framework, used to verify that the Player is legitimate and belongs to configured Steam App.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Steam Account.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingSteamResponse
Property	Type	Description
SteamID	string	The player's `SteamID` supplied by Steam Verification servers, is used as a confirmation that the Player is valid.
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingSteamError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
NoSteamAppDetailsHaveBeenConfigured	No Steam Details Configured For Project. Steam access details have not been entered into the Dashboard.
SteamAppDetailsConfiguredIncorrectly	Steam Details Have Been Configured Incorrectly. Steam Authentication has returned an error code that signals an issue with the AppID and API Key configured in Dashboard.
SteamAppIdIncompatibleWithSessionTicket	Incorrect Steam AppID For Provided Session Ticket. The Session Ticket supplied by the user does not authenticate with the Steam App ID specified in Dashboard.
SuppliedSteamTicketIsInvalid	Supplied Steam Ticket Could Not Be Authenticated. The Supplied Steam Session Ticket could not be authenticated with Steamworks Servers.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Steam

Node

PlayerAccounts \| Log In Using Steam
Property	Type	Description
SessionTicket	FString	Long Hex Code String supplied by the Steamworks Framework, used to verify that the Player is legitimate and belongs to configured Steam App.
Optionals optional	CCLogInUsingSteamRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingSteamRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Steam Account.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingSteamResponse
Property	Type	Description
SteamID	FString	The player's `SteamID` supplied by Steam Verification servers, is used as a confirmation that the Player is valid.
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingSteamError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
NoSteamAppDetailsHaveBeenConfigured	2026	No Steam Details Configured For Project. Steam access details have not been entered into the Dashboard.
SteamAppDetailsConfiguredIncorrectly	2030	Steam Details Have Been Configured Incorrectly. Steam Authentication has returned an error code that signals an issue with the AppID and API Key configured in Dashboard.
SteamAppIdIncompatibleWithSessionTicket	2031	Incorrect Steam AppID For Provided Session Ticket. The Session Ticket supplied by the user does not authenticate with the Steam App ID specified in Dashboard.
SuppliedSteamTicketIsInvalid	2025	Supplied Steam Ticket Could Not Be Authenticated. The Supplied Steam Session Ticket could not be authenticated with Steamworks Servers.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Steam

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using Twitch

Login to the system using a AuthCode from the Twitch Auth Process. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID, TwitchID and TwitchName of the logged in player.

/1.0/player/login/twitch

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
AuthCode	String	30 Character Long OAuth Token supplied by Twitch during the Twitch login process, used to verify that the Player is legitimate and has a Twitch Account.
CreatePlayer optional	Boolean	Flag which will tell ChilliConnect to create a player if there is not one associated with this Twitch Account.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
TwitchID	String	The player's `TwitchID` supplied by Twitch Authentication Servers, is used as a confirmation that the Player is valid.
TwitchName	String	The player's `Twitch Display Name`.
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2036	Supplied Twitch Auth Code Could Not Be Authenticated. The Twitch Authentication service has rejected the supplied AuthCode, this could be due to the AuthCode being used already.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
2032	No Twitch OAuth Configured For Project. ClientID, ClientSecret and RedirectURL all need to be configured to use Twitch Login.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Log In Using Twitch

Request

CCLogInUsingTwitchRequest
Property	Type	Description
AuthCode	NSString	30 Character Long OAuth Token supplied by Twitch during the Twitch login process, used to verify that the Player is legitimate and has a Twitch Account.
CreatePlayer optional	BOOL	Flag which will tell ChilliConnect to create a player if there is not one associated with this Twitch Account.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingTwitchResponse
Property	Type	Description
TwitchID	NSString	The player's `TwitchID` supplied by Twitch Authentication Servers, is used as a confirmation that the Player is valid.
TwitchName	NSString	The player's `Twitch Display Name`.
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingTwitchError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
NoTwitchOauthHasBeenConfiguredForApplication	No Twitch OAuth Configured For Project. ClientID, ClientSecret and RedirectURL all need to be configured to use Twitch Login.
SuppliedTwitchAuthCodeInvalid	Supplied Twitch Auth Code Could Not Be Authenticated. The Twitch Authentication service has rejected the supplied AuthCode, this could be due to the AuthCode being used already.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Twitch

Request

LogInUsingTwitchRequest
Property	Type	Description
AuthCode	string	30 Character Long OAuth Token supplied by Twitch during the Twitch login process, used to verify that the Player is legitimate and has a Twitch Account.
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Twitch Account.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingTwitchResponse
Property	Type	Description
TwitchID	string	The player's `TwitchID` supplied by Twitch Authentication Servers, is used as a confirmation that the Player is valid.
TwitchName	string	The player's `Twitch Display Name`.
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingTwitchError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
NoTwitchOauthHasBeenConfiguredForApplication	No Twitch OAuth Configured For Project. ClientID, ClientSecret and RedirectURL all need to be configured to use Twitch Login.
SuppliedTwitchAuthCodeInvalid	Supplied Twitch Auth Code Could Not Be Authenticated. The Twitch Authentication service has rejected the supplied AuthCode, this could be due to the AuthCode being used already.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Twitch

Node

PlayerAccounts \| Log In Using Twitch
Property	Type	Description
AuthCode	FString	30 Character Long OAuth Token supplied by Twitch during the Twitch login process, used to verify that the Player is legitimate and has a Twitch Account.
Optionals optional	CCLogInUsingTwitchRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingTwitchRequestOptionalsDesc
Property	Type	Description
CreatePlayer optional	bool	Flag which will tell ChilliConnect to create a player if there is not one associated with this Twitch Account.
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingTwitchResponse
Property	Type	Description
TwitchID	FString	The player's `TwitchID` supplied by Twitch Authentication Servers, is used as a confirmation that the Player is valid.
TwitchName	FString	The player's `Twitch Display Name`.
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingTwitchError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
NoTwitchOauthHasBeenConfiguredForApplication	2032	No Twitch OAuth Configured For Project. ClientID, ClientSecret and RedirectURL all need to be configured to use Twitch Login.
SuppliedTwitchAuthCodeInvalid	2036	Supplied Twitch Auth Code Could Not Be Authenticated. The Twitch Authentication service has rejected the supplied AuthCode, this could be due to the AuthCode being used already.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using Twitch

Available in the HTTP, iOS, Unity, Unreal APIs.

Log In Using User Name

Login to the system using an UserName and Password. Returns an ConnectAccessToken that is tied to the player and should be used to authenticate on subsequent requests. Also returns the ChilliConnectID of the logged in player.

/2.0/player/login/username

Header

Field	Type	Description
Game-Token	String	The Game to log in to.

Parameter

Field	Type	Description
UserName	String	The player's Username.
Password	String	The player's Password.
Country optional	String	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	String	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	String	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	String	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
Date	String	The local device time that the session started. Format: ISO8601 e.g. `2016-01-12T11:08:23`.
AppVersion optional	String	The client version of your game.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's `ChilliConnectID`.
CatalogVersion	String	The Catalog Version.
ConnectAccessToken	String	A time limited ConnectAccessToken that should be used to authenticate the player on subsequent requests.
MetricsAccessToken	String	MetricsAccessToken required as a header for other API calls.

Error 401

Code	Description
1001	Invalid Game Token. The provided `Game-Token` was not recognised.
1005	Invalid Credentials. The supplied credentials were not recognised.
1013	Trial Expired. Trial Period Expired

Error 403

Code	Description
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10001	Limit Reached. The DAU limit for today has been reached.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "ConnectAccessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzODY4OTkxMzEsImlzcyI6ImppcmE6MTU0ODk1OTUiLCJxc2giOiI4MDYzZmY0Y2ExZTQxZGY3YmM5MGM4YWI2ZDBmNjIwN2Q0OTFjZjZkYWQ3YzY2ZWE3OTdiNDYxNGI3MTkyMmU5IiwiaWF0IjoxMzg2ODk4OTUxfQ.uKqU9dTB6gKwG6jQCuXYAiMNdfNRw98Hw_IWuA5MaMo",
 "MetricsAccessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uVG9rZW4iOiI0ZTJhM2NmYS02MjNjLTExZTctYTNlZC0wODAwMjc4Yjc4YTYiLCJ1c2VySWQiOiJWMWFISjBLTDFUdjZ2R1BKYWVaTVd2bVo1MDh0UktCTSIsImN3QXBwSWQiOiIyIn0.GHIuB7fV_yGgPY3nvjZ1LlLBr8sEDgisQg6gkRVMtkE",
 "ChilliConnectID" : "284LD4sAB5Ygo2RSl8h4vVW48qAbA8Cr",
 "CatalogVersion" : "e0200111daaa5839e6f310ce2d843189"
}

Log In Using User Name

Request

CCLogInUsingUserNameRequest
Property	Type	Description
UserName	NSString	The player's Username.
Password	NSString	The player's Password.
Country optional	NSString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	NSString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	NSString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	NSString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	NSString	The client version of your game.

Response

CCLogInUsingUserNameResponse
Property	Type	Description
ChilliConnectID	NSString	The player's `ChilliConnectID`.
CatalogVersion optional	NSString	The Catalog Version.

Errors

CCLogInUsingUserNameError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

CCPlayerAccounts *playerAccounts = chilliConnect.playerAccounts;

CCLogInUsingUserNameResponseCallback successCallback = ^(CCLogInUsingUserNameRequest *request, CCLogInUsingUserNameResponse *response) {
    NSLog(@"Successfully logged in!");
};

CCLogInUsingUserNameErrorCallback errorCallback = ^(CCLogInUsingUserNameRequest *request, CCLogInUsingUserNameError *error) {
    NSLog(@"An error occurred while logging in: %@", error.errorDescription);
};

CCLogInUsingUserNameRequestDesc *desc = [CCLogInUsingUserNameRequestDesc logInUsingUserNameRequestDescWithUserName:@"UserName" password:@"Password"];
[playerAccounts logInUsingUserName:desc successCallback:successCallback errorCallback:errorCallback];

Log In Using User Name

Request

LogInUsingUserNameRequest
Property	Type	Description
UserName	string	The player's Username.
Password	string	The player's Password.
Country optional	string	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	string	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	string	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	string	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	string	The client version of your game.

Response

LogInUsingUserNameResponse
Property	Type	Description
ChilliConnectID	string	The player's `ChilliConnectID`.
CatalogVersion optional	string	The Catalog Version.

Errors

LogInUsingUserNameError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	Trial Expired. Trial Period Expired
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

var playerAccounts = chilliConnect.PlayerAccounts;

Action<LogInUsingUserNameRequest, LogInUsingUserNameResponse> successCallback = (LogInUsingUserNameRequest request, LogInUsingUserNameResponse response) =>
{
    UnityEngine.Debug.Log("Successfully logged in!");
};

Action<LogInUsingUserNameRequest, LogInUsingUserNameError> errorCallback = (LogInUsingUserNameRequest request, LogInUsingUserNameError error) =>
{
    UnityEngine.Debug.Log("An error occurred while logging in: " + error.ErrorDescription);
};

var loginDesc = new LogInUsingUserNameRequestDesc("UserName", "Password");
playerAccounts.LogInUsingUserName(loginDesc, successCallback, errorCallback);

Log In Using User Name

Node

PlayerAccounts \| Log In Using User Name
Property	Type	Description
UserName	FString	The player's Username.
Password	FString	The player's Password.
Optionals optional	CCLogInUsingUserNameRequestOptionalsDesc	Optional properties for this request.

CCLogInUsingUserNameRequestOptionalsDesc
Property	Type	Description
Country optional	FString	The `Country` currently associated with the account. Format: `ISO 3166-1 alpha-2`.
DeviceModel optional	FString	Model of device being used by the player. E.g. `SamsungABC123`.
DeviceType optional	FString	Type of device being used by the player. Accepted values: `PHONE`, `TABLET`, `BROWSER`, `DESKTOP`, `OTHER`.
Platform optional	FString	Platform of the device being used by the player. A string containing one of the accepted values will be mapped to the accepted value. Accepted values: `ANDROID`, `IOS`, `KINDLE`, `WINDOWS`, `MACOS`, `LINUX`, `OTHER`.
AppVersion optional	FString	The client version of your game.

Response

CCLogInUsingUserNameResponse
Property	Type	Description
ChilliConnectID	FString	The player's `ChilliConnectID`.
CatalogVersion optional	FString	The Catalog Version.

Errors

CCLogInUsingUserNameError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
InvalidCredentials	1005	Invalid Credentials. The supplied credentials were not recognised.
InvalidGameToken	1001	Invalid Game Token. The provided `Game-Token` was not recognised.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
LimitReached	10001	Limit Reached. The DAU limit for today has been reached.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
TrialExpired	1013	Trial Expired. Trial Period Expired
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Log In Using User Name

Available in the HTTP, iOS, Unity, Unreal APIs.

Link Mobile Device Id

Associate a unique Mobile DeviceID with a player account. Each player can have multiple devices of the same platform linked with their account, so long as the combination of DeviceID and Platform are unique.

If the player is already associated with a DeviceID and Platform, an error will be returned

If the DeviceID and Platform are already associated with another player within this game, an error will be returned along with the ChilliConnectID for the associated player within the data parameter of the response body. If the Update flag is provided, the existing association will be removed and DeviceID and Platform will be associated with the current ChilliConnect account.

/1.0/player/link/device

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Parameter

Field	Type	Description
DeviceID	String	DeviceId generated on the Players current device.
Platform	String	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.
Update optional	Boolean	When set to `true` will remove any existing associations this DeviceID and Platform already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Success 200

Field	Type	Description
DeviceID	String	The player's DeviceID as sent by the Device.
Platform	String	The player's device Platform, as sent by the Device.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2022	DeviceID Linked With Another Player. The supplied DeviceID is linked with another PLayer.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Link Mobile Device Id

If the player is already associated with a DeviceID and Platform, an error will be returned

Request

CCLinkMobileDeviceIdRequest
Property	Type	Description
DeviceID	NSString	DeviceId generated on the Players current device.
Platform	NSString	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.
Update optional	BOOL	When set to `true` will remove any existing associations this DeviceID and Platform already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	NSString	The player's DeviceID as sent by the Device.
Platform	NSString	The player's device Platform, as sent by the Device.

Errors

CCLinkMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
DeviceIdLinkedWithAnotherUser	DeviceID Linked With Another Player. The supplied DeviceID is linked with another PLayer.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Mobile Device Id

If the player is already associated with a DeviceID and Platform, an error will be returned

Request

LinkMobileDeviceIdRequest
Property	Type	Description
DeviceID	string	DeviceId generated on the Players current device.
Platform	string	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.
Update optional	bool	When set to `true` will remove any existing associations this DeviceID and Platform already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

LinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	string	The player's DeviceID as sent by the Device.
Platform	string	The player's device Platform, as sent by the Device.

Errors

LinkMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
DeviceIdLinkedWithAnotherUser	DeviceID Linked With Another Player. The supplied DeviceID is linked with another PLayer.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Mobile Device Id

If the player is already associated with a DeviceID and Platform, an error will be returned

Node

PlayerAccounts \| Link Mobile Device Id
Property	Type	Description
DeviceID	FString	DeviceId generated on the Players current device.
Platform	FString	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.
Optionals optional	CCLinkMobileDeviceIdRequestOptionalsDesc	Optional properties for this request.

CCLinkMobileDeviceIdRequestOptionalsDesc
Property	Type	Description
Update optional	bool	When set to `true` will remove any existing associations this DeviceID and Platform already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	FString	The player's DeviceID as sent by the Device.
Platform	FString	The player's device Platform, as sent by the Device.

Errors

CCLinkMobileDeviceIdError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
DeviceIdLinkedWithAnotherUser	2022	DeviceID Linked With Another Player. The supplied DeviceID is linked with another PLayer.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Link Mobile Device Id

If the player is already associated with a DeviceID and Platform, an error will be returned

Available in the HTTP, iOS, Unity, Unreal APIs.

Unlink Mobile Device Id

Remove an association between a player and a DeviceId previously created via the LinkMobileDeviceId method.

/1.0/player/unlink/device

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Parameter

Field	Type	Description
DeviceID	String	DeviceId generated on the Players current device.
Platform	String	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.

Success 200

Field	Type	Description
DeviceID	String	The player's DeviceId as sent by the Device.
Platform	String	The player's device Platform, as sent by the Device.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
2023	Player Not Linked To A DeviceID. The current Player is not linked to a DeviceID.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Unlink Mobile Device Id

Remove an association between a player and a DeviceId previously created via the LinkMobileDeviceId method.

Request

CCUnlinkMobileDeviceIdRequest
Property	Type	Description
DeviceID	NSString	DeviceId generated on the Players current device.
Platform	NSString	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.

Response

CCUnlinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	NSString	The player's DeviceId as sent by the Device.
Platform	NSString	The player's device Platform, as sent by the Device.

Errors

CCUnlinkMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToADeviceId	Player Not Linked To A DeviceID. The current Player is not linked to a DeviceID.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Mobile Device Id

Remove an association between a player and a DeviceId previously created via the LinkMobileDeviceId method.

Request

UnlinkMobileDeviceIdRequest
Property	Type	Description
DeviceID	string	DeviceId generated on the Players current device.
Platform	string	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.

Response

UnlinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	string	The player's DeviceId as sent by the Device.
Platform	string	The player's device Platform, as sent by the Device.

Errors

UnlinkMobileDeviceIdError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToADeviceId	Player Not Linked To A DeviceID. The current Player is not linked to a DeviceID.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Mobile Device Id

Remove an association between a player and a DeviceId previously created via the LinkMobileDeviceId method.

Node

PlayerAccounts \| Unlink Mobile Device Id
Property	Type	Description
DeviceID	FString	DeviceId generated on the Players current device.
Platform	FString	Platform of the Players current Device. Must only be ANDROID, IOS, or KINDLE.

Response

CCUnlinkMobileDeviceIdResponse
Property	Type	Description
DeviceID	FString	The player's DeviceId as sent by the Device.
Platform	FString	The player's device Platform, as sent by the Device.

Errors

CCUnlinkMobileDeviceIdError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToADeviceId	2023	Player Not Linked To A DeviceID. The current Player is not linked to a DeviceID.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Mobile Device Id

Remove an association between a player and a DeviceId previously created via the LinkMobileDeviceId method.

Available in the HTTP, iOS, Unity, Unreal APIs.

Link Game Center Account

Associate a player account with a GameCenterID. Each player can only be associated with a single GameCenterID and a GameCenterID can only be associated with a single player per game.

If the player is already associated with a GameCenterID an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

If the GameCenterID is already associated with another player within this game, an error will be returned along with the ChilliConnectID for the associated player within the data parameter of the response body. If the Update flag is provided, the existing association will be removed and GameCenterID associated with the current ChilliConnect account.

/2.0/player/link/gamecenter

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Parameter

Field	Type	Description
GameCenterID	String	GameCenterID provided by the client.
Replace optional	Boolean	When set to `true`, any existing GameCenterID association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	Boolean	When set to `true` will remove any existing associations this GameCenterID account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's ChilliConnectID.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2011	Game Center Account Linked With Another Player. The Game Center account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
2012	Player Already Linked With Game Center. The player is already associated with a GameCenter ID. The details of the Game Center account will be provided in the `data` attribute of the response body.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Link Game Center Account

Associate a player account with a GameCenterID. Each player can only be associated with a single GameCenterID and a GameCenterID can only be associated with a single player per game.

If the player is already associated with a GameCenterID an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

CCLinkGameCenterAccountRequest
Property	Type	Description
GameCenterID	NSString	GameCenterID provided by the client.
Replace optional	BOOL	When set to `true`, any existing GameCenterID association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	BOOL	When set to `true` will remove any existing associations this GameCenterID account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	NSString	The player's ChilliConnectID.

Errors

CCLinkGameCenterAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GameCenterAccountLinkedWithAnotherPlayer	Game Center Account Linked With Another Player. The Game Center account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithGameCenter	Player Already Linked With Game Center. The player is already associated with a GameCenter ID. The details of the Game Center account will be provided in the `data` attribute of the response body.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Game Center Account

Associate a player account with a GameCenterID. Each player can only be associated with a single GameCenterID and a GameCenterID can only be associated with a single player per game.

If the player is already associated with a GameCenterID an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

LinkGameCenterAccountRequest
Property	Type	Description
GameCenterID	string	GameCenterID provided by the client.
Replace optional	bool	When set to `true`, any existing GameCenterID association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this GameCenterID account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

LinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	string	The player's ChilliConnectID.

Errors

LinkGameCenterAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GameCenterAccountLinkedWithAnotherPlayer	Game Center Account Linked With Another Player. The Game Center account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithGameCenter	Player Already Linked With Game Center. The player is already associated with a GameCenter ID. The details of the Game Center account will be provided in the `data` attribute of the response body.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Examples

Link GameCenter Account

var playerAccounts = chilliConnect.PlayerAccounts;

Action<LinkGameCenterAccountRequest, LinkGameCenterAccountResponse> successCallback = (LinkGameCenterAccountRequest request, LinkGameCenterAccountResponse response) =>
{
    ChilliConnectId = response.ChilliConnectId;
    
    UnityEngine.Debug.Log("GameCenter ID linked with ChilliConnectId: " + ChilliConnectId);
};

Action<LinkGameCenterAccountRequest, LinkGameCenterAccountError> errorCallback = (LinkGameCenterAccountRequest request, LinkGameCenterAccountError error) =>
{
    UnityEngine.Debug.Log("An error occurred while linking player with account: " + error.ErrorDescription);
};

var requestDesc = new LinkGameCenterAccountDesc();

Social.localUser.Authenticate (success => {
    if (success) {
        requestDesc.GameCenterID = Social.localUser.id;

        playerAccounts.LinkGameCenterAccount(requestDesc, successCallback, errorCallback);1
    } else {
        Debug.Log("Authentication failed");
    }
});

Link Game Center Account

Associate a player account with a GameCenterID. Each player can only be associated with a single GameCenterID and a GameCenterID can only be associated with a single player per game.

If the player is already associated with a GameCenterID an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Node

PlayerAccounts \| Link Game Center Account
Property	Type	Description
GameCenterID	FString	GameCenterID provided by the client.
Optionals optional	CCLinkGameCenterAccountRequestOptionalsDesc	Optional properties for this request.

CCLinkGameCenterAccountRequestOptionalsDesc
Property	Type	Description
Replace optional	bool	When set to `true`, any existing GameCenterID association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this GameCenterID account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	FString	The player's ChilliConnectID.

Errors

CCLinkGameCenterAccountError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GameCenterAccountLinkedWithAnotherPlayer	2011	Game Center Account Linked With Another Player. The Game Center account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithGameCenter	2012	Player Already Linked With Game Center. The player is already associated with a GameCenter ID. The details of the Game Center account will be provided in the `data` attribute of the response body.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Link Game Center Account

Associate a player account with a GameCenterID. Each player can only be associated with a single GameCenterID and a GameCenterID can only be associated with a single player per game.

If the player is already associated with a GameCenterID an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Available in the HTTP, iOS, Unity, Unreal APIs.

Unlink Game Center Account

Remove an associate between a player and a GameCenter account previously created via the LinkGameCenterAccount method.

/1.0/player/unlink/gamecenter

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's ChilliConnectID.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
2013	Player Not Linked To GameCenter. The current player has no linked GameCenter account.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Unlink Game Center Account

Remove an associate between a player and a GameCenter account previously created via the LinkGameCenterAccount method.

Request

CCUnlinkGameCenterAccountRequest
Property	Type	Description
None

Response

CCUnlinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	NSString	The player's ChilliConnectID.

Errors

CCUnlinkGameCenterAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToGameCenter	Player Not Linked To GameCenter. The current player has no linked GameCenter account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Game Center Account

Remove an associate between a player and a GameCenter account previously created via the LinkGameCenterAccount method.

Request

UnlinkGameCenterAccountRequest
Property	Type	Description
None

Response

UnlinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	string	The player's ChilliConnectID.

Errors

UnlinkGameCenterAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToGameCenter	Player Not Linked To GameCenter. The current player has no linked GameCenter account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Game Center Account

Remove an associate between a player and a GameCenter account previously created via the LinkGameCenterAccount method.

Node

PlayerAccounts \| Unlink Game Center Account
Property	Type	Description
None

Response

CCUnlinkGameCenterAccountResponse
Property	Type	Description
ChilliConnectID	FString	The player's ChilliConnectID.

Errors

CCUnlinkGameCenterAccountError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToGameCenter	2013	Player Not Linked To GameCenter. The current player has no linked GameCenter account.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Game Center Account

Remove an associate between a player and a GameCenter account previously created via the LinkGameCenterAccount method.

Available in the HTTP, iOS, Unity, Unreal APIs.

Link Facebook Account

Associate a player account with a Facebook account. Each player can only be associated with a single Facebook account and a Facebook account can only be associated with a single player per game.

If the player is already associated with a Facebook account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

If the Facebook account is already associated with another player within this game, an error will be returned along with the FacebookID and FacebookName for the associated player within the data parameter of the response body. If the Update flag is provided, the existing association will be removed and Facebook account associated with the current ChilliConnect account.

/2.0/player/link/facebook

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Parameter

Field	Type	Description
FacebookAccessToken	String	Access token provided from the Facebook API.
Replace optional	Boolean	When set to `true`, any existing Facebook association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	Boolean	When set to `true` will remove any existing associations this Facebook account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Success 200

Field	Type	Description
FacebookID	String	The player's Facebook account ID.
FacebookName	String	The player's Facebook name.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2003	Player Already Linked With Facebook. The player is already associated with a Facebook account. The details of the Facebook account will be provided in the `data` attribute of the response body.
2004	Facebook Account Linked With Another Player. The Facebook account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
2002	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "FacebookName" : "MikeHerron",
 "FacebookID"   : "12345"
}

Link Facebook Account

Associate a player account with a Facebook account. Each player can only be associated with a single Facebook account and a Facebook account can only be associated with a single player per game.

If the player is already associated with a Facebook account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

CCLinkFacebookAccountRequest
Property	Type	Description
FacebookAccessToken	NSString	Access token provided from the Facebook API.
Replace optional	BOOL	When set to `true`, any existing Facebook association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	BOOL	When set to `true` will remove any existing associations this Facebook account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkFacebookAccountResponse
Property	Type	Description
FacebookID	NSString	The player's Facebook account ID.
FacebookName	NSString	The player's Facebook name.

Errors

CCLinkFacebookAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
FacebookAccessTokenInvalid	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
FacebookAccountLinkedWithAnotherPlayer	Facebook Account Linked With Another Player. The Facebook account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithFacebook	Player Already Linked With Facebook. The player is already associated with a Facebook account. The details of the Facebook account will be provided in the `data` attribute of the response body.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Facebook Account

Associate a player account with a Facebook account. Each player can only be associated with a single Facebook account and a Facebook account can only be associated with a single player per game.

If the player is already associated with a Facebook account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

LinkFacebookAccountRequest
Property	Type	Description
FacebookAccessToken	string	Access token provided from the Facebook API.
Replace optional	bool	When set to `true`, any existing Facebook association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this Facebook account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

LinkFacebookAccountResponse
Property	Type	Description
FacebookID	string	The player's Facebook account ID.
FacebookName	string	The player's Facebook name.

Errors

LinkFacebookAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
FacebookAccessTokenInvalid	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
FacebookAccountLinkedWithAnotherPlayer	Facebook Account Linked With Another Player. The Facebook account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithFacebook	Player Already Linked With Facebook. The player is already associated with a Facebook account. The details of the Facebook account will be provided in the `data` attribute of the response body.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Facebook Account

Associate a player account with a Facebook account. Each player can only be associated with a single Facebook account and a Facebook account can only be associated with a single player per game.

If the player is already associated with a Facebook account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Node

PlayerAccounts \| Link Facebook Account
Property	Type	Description
FacebookAccessToken	FString	Access token provided from the Facebook API.
Optionals optional	CCLinkFacebookAccountRequestOptionalsDesc	Optional properties for this request.

CCLinkFacebookAccountRequestOptionalsDesc
Property	Type	Description
Replace optional	bool	When set to `true`, any existing Facebook association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this Facebook account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkFacebookAccountResponse
Property	Type	Description
FacebookID	FString	The player's Facebook account ID.
FacebookName	FString	The player's Facebook name.

Errors

CCLinkFacebookAccountError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
FacebookAccessTokenInvalid	2002	Facebook Access Token Invalid. The supplied Facebook Access Token could not be validated against the Facebook API.
FacebookAccountLinkedWithAnotherPlayer	2004	Facebook Account Linked With Another Player. The Facebook account is already linked with another player of this game. The `ChilliConnectID` of this player will be provided in the `data` attribute of the response body.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerAlreadyLinkedWithFacebook	2003	Player Already Linked With Facebook. The player is already associated with a Facebook account. The details of the Facebook account will be provided in the `data` attribute of the response body.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Link Facebook Account

Associate a player account with a Facebook account. Each player can only be associated with a single Facebook account and a Facebook account can only be associated with a single player per game.

If the player is already associated with a Facebook account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Available in the HTTP, iOS, Unity, Unreal APIs.

Unlink Facebook Account

Remove an associate between a player and a Facebook account previously created via the LinkFacebookAccount method.

/1.0/player/unlink/facebook

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Success 200

Field	Type	Description
FacebookID	String	The player's Facebook ID of the unlinked account.
FacebookName	String	The player's Facebook name of the unlinked account.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 422

Code	Description
2005	Player Not Linked To Facebook. The current player has no linked Facebook account.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Examples

Success Response

HTTP/1.1 200 OK
{
 "FacebookName" : "MikeHerron",
 "FacebookID"   : "12345"
}

Unlink Facebook Account

Remove an associate between a player and a Facebook account previously created via the LinkFacebookAccount method.

Request

CCUnlinkFacebookAccountRequest
Property	Type	Description
None

Response

CCUnlinkFacebookAccountResponse
Property	Type	Description
FacebookID	NSString	The player's Facebook ID of the unlinked account.
FacebookName	NSString	The player's Facebook name of the unlinked account.

Errors

CCUnlinkFacebookAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToFacebook	Player Not Linked To Facebook. The current player has no linked Facebook account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Facebook Account

Remove an associate between a player and a Facebook account previously created via the LinkFacebookAccount method.

Request

UnlinkFacebookAccountRequest
Property	Type	Description
None

Response

UnlinkFacebookAccountResponse
Property	Type	Description
FacebookID	string	The player's Facebook ID of the unlinked account.
FacebookName	string	The player's Facebook name of the unlinked account.

Errors

UnlinkFacebookAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToFacebook	Player Not Linked To Facebook. The current player has no linked Facebook account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Facebook Account

Remove an associate between a player and a Facebook account previously created via the LinkFacebookAccount method.

Node

PlayerAccounts \| Unlink Facebook Account
Property	Type	Description
None

Response

CCUnlinkFacebookAccountResponse
Property	Type	Description
FacebookID	FString	The player's Facebook ID of the unlinked account.
FacebookName	FString	The player's Facebook name of the unlinked account.

Errors

CCUnlinkFacebookAccountError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
PlayerNotLinkedToFacebook	2005	Player Not Linked To Facebook. The current player has no linked Facebook account.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Unlink Facebook Account

Remove an associate between a player and a Facebook account previously created via the LinkFacebookAccount method.

Available in the HTTP, iOS, Unity, Unreal APIs.

Link Google Account

Associate a player account with a Google account. Each player can only be associated with a single Google account and a Google account can only be associated with a single player per game.

If the player is already associated with a Google account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

If the Google account is already associated with another player within this game, an error will be returned along with the ChilliConnectID for the associated player within the data parameter of the response body. If the Update flag is provided, the existing association will be removed and Google account associated with the current ChilliConnect account.

/2.0/player/link/google

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Parameter

Field	Type	Description
AuthCode	String	Authorisation Code provided by Google, obtainable on the Client through Google Play.
Replace optional	Boolean	When set to `true`, any existing Google account association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	Boolean	When set to `true` will remove any existing associations this Google account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's ChilliConnectID.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.

Error 403

Code	Description
1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.

Error 409

Code	Description
2014	Player Already Linked With A Google Account. The Google account is already linked with another player of this game.
2015	GoogleId Is Already Linked With Another Player. The supplied Google ID is already associated with another player.
2018	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
2019	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
2020	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
2021	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.

Error 422

Code	Description
1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
2016	Player Not Linked To Google. The current Player is not linked to a Google account.

Error 429

Code	Description
10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.

Error 500

Code	Description
1	Unexpected Error. An unexpected, fatal error has occurred.

Error 503

Code	Description
1008	Temporary Service Error. A temporary error is preventing the request from being processed.

Link Google Account

Associate a player account with a Google account. Each player can only be associated with a single Google account and a Google account can only be associated with a single player per game.

If the player is already associated with a Google account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

CCLinkGoogleAccountRequest
Property	Type	Description
AuthCode	NSString	Authorisation Code provided by Google, obtainable on the Client through Google Play.
Replace optional	BOOL	When set to `true`, any existing Google account association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	BOOL	When set to `true` will remove any existing associations this Google account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkGoogleAccountResponse
Property	Type	Description
ChilliConnectID	NSString	The player's ChilliConnectID.

Errors

CCLinkGoogleAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GoogleAccountLinked	GoogleId Is Already Linked With Another Player. The supplied Google ID is already associated with another player.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
NoGoogleOauthHasBeenConfiguredForApplication	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
PlayerAlreadyLinkedToGoogleAccount	Player Already Linked With A Google Account. The Google account is already linked with another player of this game.
PlayerNotLinkedToGoogle	Player Not Linked To Google. The current Player is not linked to a Google account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
SuppliedAuthCodeAlreadyRedeemed	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Google Account

Associate a player account with a Google account. Each player can only be associated with a single Google account and a Google account can only be associated with a single player per game.

If the player is already associated with a Google account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Request

LinkGoogleAccountRequest
Property	Type	Description
AuthCode	string	Authorisation Code provided by Google, obtainable on the Client through Google Play.
Replace optional	bool	When set to `true`, any existing Google account association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this Google account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

LinkGoogleAccountResponse
Property	Type	Description
ChilliConnectID	string	The player's ChilliConnectID.

Errors

LinkGoogleAccountError
Name	Description
AccountRestriction	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GoogleAccountLinked	GoogleId Is Already Linked With Another Player. The supplied Google ID is already associated with another player.
InvalidConnectAccessToken	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
NoGoogleOauthHasBeenConfiguredForApplication	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
PlayerAlreadyLinkedToGoogleAccount	Player Already Linked With A Google Account. The Google account is already linked with another player of this game.
PlayerNotLinkedToGoogle	Player Not Linked To Google. The current Player is not linked to a Google account.
RateLimitReached	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
SuppliedAuthCodeAlreadyRedeemed	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	Unexpected Error. An unexpected, fatal error has occurred.

Link Google Account

Associate a player account with a Google account. Each player can only be associated with a single Google account and a Google account can only be associated with a single player per game.

If the player is already associated with a Google account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Node

PlayerAccounts \| Link Google Account
Property	Type	Description
AuthCode	FString	Authorisation Code provided by Google, obtainable on the Client through Google Play.
Optionals optional	CCLinkGoogleAccountRequestOptionalsDesc	Optional properties for this request.

CCLinkGoogleAccountRequestOptionalsDesc
Property	Type	Description
Replace optional	bool	When set to `true`, any existing Google account association for the current use will be replaced. Otherwise, an error will be returned. Default `false`.
Update optional	bool	When set to `true` will remove any existing associations this Google account already has with another player of this game. Otherwise, an error will be returned. Default `false`.

Response

CCLinkGoogleAccountResponse
Property	Type	Description
ChilliConnectID	FString	The player's ChilliConnectID.

Errors

CCLinkGoogleAccountError
Error	Code	Description
AccountRestriction	10003	Account Restriction. Account does not have access to this feature, or has exceeded the usage limit.
ExpiredConnectAccessToken	1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
GoogleAccountLinked	2015	GoogleId Is Already Linked With Another Player. The supplied Google ID is already associated with another player.
InvalidConnectAccessToken	1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.
InvalidRequest	1007	Invalid Request. One of more of the provided fields were not correctly formatted. The `data` property of the response body will contain specific error messages for each field.
MethodDisabled	1011	Method Disabled. Public access to this method has been disabled on the ChilliConnect Dashboard.
NoGoogleOauthHasBeenConfiguredForApplication	2018	No Google OAuth Configured For Project. Get the appropriate OAuth information from your google-services.json file or the Google Developer Console and configure your Game in the ChilliConnect Dashboard Api Settings area.
PlayerAlreadyLinkedToGoogleAccount	2014	Player Already Linked With A Google Account. The Google account is already linked with another player of this game.
PlayerNotLinkedToGoogle	2016	Player Not Linked To Google. The current Player is not linked to a Google account.
RateLimitReached	10002	Rate Limit Reached. Too many requests. Player has been rate limited. The data property of the response may contain more details.
SuppliedAuthCodeAlreadyRedeemed	2019	Supplied Auth Code Has Already Been Redeemed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode has already been previously accepted by the service and requires a fresh code.
SuppliedAuthCodeInvalid	2021	Supplied Auth Code Could Not Be Authenticated. The Google verification service has rejected the supplied AuthCode. This could be due to configuration error, ensure all Google Developer Console values have been configured.
SuppliedAuthCodeMalformed	2020	Supplied Auth Code Is Malformed. The Google verification service has rejected the supplied AuthCode. The supplied AuthCode is malformed, please check the formatting.
TemporaryServiceError	1008	Temporary Service Error. A temporary error is preventing the request from being processed.
Unexpected	1	Unexpected Error. An unexpected, fatal error has occurred.

Link Google Account

Associate a player account with a Google account. Each player can only be associated with a single Google account and a Google account can only be associated with a single player per game.

If the player is already associated with a Google account an error will be returned, unless the Replace flag is provided, in which case the association will be updated.

Available in the HTTP, iOS, Unity, Unreal APIs.

Unlink Google Account

Remove an associate between a player and a Google account previously created via the LinkGoogleAccount method.

/1.0/player/unlink/google

Header

Field	Type	Description
Connect-Access-Token	String	A valid session ConnectAccessToken obtained through one of the login endpoints.

Success 200

Field	Type	Description
ChilliConnectID	String	The player's ChilliConnectID.

Error 401

Code	Description
1003	Expired Connect Access Token. The `Connect-Access-Token` used to authenticate with the server has expired and should be renewed.
1004	Invalid Connect Access Token. The `Connect-Access-Token` was not valid and cannot be used to authenticate requests.