Our SDKs provide an easy way to quickly integrate ChilliConnect in to your game. We currently provide both a Unity and an iOS SDK and will soon be adding Android and ChilliSource. If the SDK you want is currently unavailable you can still call our HTTP API directly.



I agree to the Terms of Service

The Unity SDK describes a C# API for ChilliConnect and comes bundled as a Unity Package which can be easily added to your project. The SDK is written entirely in C# and does not require any plugins. The following details how to install and use the SDK. You can also browse the Doxygen documentation.


Follow these steps to include ChilliConnect in your Unity project:


The following describes the steps requested to setup ChilliConnect in your Unity project.

using ChilliConnect;
var chilliConnect = new ChilliConnectSdk("<YourGameToken>", false);
var metrics = chilliConnect.Metrics;
Action<StartSessionRequest> successCallback = (StartSessionRequest request) =>
    UnityEngine.Debug.Log("Successfully started session!");

Action<StartSessionRequest, StartSessionError> errorCallback = (StartSessionRequest request, StartSessionError error) =>
    UnityEngine.Debug.Log("An error occurred while starting the session: " + error.ErrorDescription);

var desc = new StartSessionRequestDesc (userId, "Unity-v1.0");
metrics.StartSession(desc, successCallback, errorCallback);

See the full API documentation for more information on the available modules and methods.



I agree to the Terms of Service

The iOS SDK provides an Objective-C API for ChilliConnect that iOS developers should find easy to use. The following sections detail how to install and use the SDK. You can also browse the Doxygen documentation.


Follow the below steps to add the iOS SDK to your project:


The following are the steps required to setup the ChilliConnect iOS SDK for use in your project.

#import <ChilliConnect/ChilliConnect.h>
CCChilliConnectSdk *chilliConnect = [CCChilliConnectSdk chilliConnectSdkWithAppToken:@"<YourGameToken>" verboseLogging:NO];
CCMetrics *metrics = chilliConnect.metrics;
CCStartSessionResponseCallback successCallback = ^(CCStartSessionRequest *request) {
    NSLog(@"Successfully started session!");

CCStartSessionErrorCallback errorCallback = ^(CCStartSessionRequest *request, CCStartSessionError *error) {
    NSLog(@"An error occurred while starting a metrics session: %@", error.errorDescription);

CCStartSessionRequestDesc *desc = [CCStartSessionRequestDesc startSessionRequestDescWithUserId:userId appVersion:@"1.0"];
[metrics startSessionWithDesc:desc successCallback:successCallback errorCallback:errorCallback];

For more information on the different requests available in each module, see the full API documentation.


The easiest way to integrate ChilliConnect in to your game is to use one of our published SDKs. However, if the SDK you want is not currently available, all ChilliConnect functionality is exposed through an easy to use HTTPS API that you can invoke directly from your game.

The API is separated in to modules and exposed through two separate end points. Each API endpoint is also versioned, with the current version being 1.0. The following table describes the end point for each module:

Module Domain
Cloud Code
Cloud Data
Player Accounts
Push Notifications
IAP Validation
Live Ops

The API for both Connect and Metrics follow a similar usage pattern. For both, you must first use your GameToken, available from your ChilliConnect dashboard, to authenticate and obtain an AccessToken. You then use this AccessToken on subsequent requests.

By default when Logging in to Connect both a ConnectAccessToken, and MetricsAccessToken are returned, e.g. LogInUsingChilliConnect. It is also possible to get a MetricsAccessToken by invoking the StartSession end point. Note that AccessTokens are not interchangeable between Metrics and Connect API endpoints.

To call a specific method on the API simply post the required JSON body to the URL indicated in the documentation below to the relevant endpoint whilst setting the Content-Type header to "application/json". For example, the below curl command shows how to call the CreatePlayer method:

curl \
 -H "Content-Type: application/json" \\
 -H "Game-Token: <YourGameTokenHere>" \