Catalog

The ChillConnect Admin API Catalog module. Provides the means to retrieve and manipulate catalog items.

Get Catalog Versions

Get all catalog versions.

https://adminapi.chilliconnect.com/game/{token}/catalog/versions

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

HTTP Status 200

Field Type Description
Response

JSON

A list of versions, with their version ID, package URL and date published.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Get Catalog Version Diff

Get difference between requested and previous version

https://adminapi.chilliconnect.com/game/{token}/catalog/versions/diff/{version}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

HTTP Status 200

Field Type Description
VersionDiff

Object

  RequestedVersion

Object

Contains information on the requested version.

    Version

String

Version identifier.

    DatePublished

String

Date of the version being published (UTC). Format: ISO8601 e.g. 2016-01-12T11:08:23.

  PreviousVersion

Object

Contains information on the previous version to the one requested.

    Version

String

Version identifier.

    DatePublished

String

Date of the version being published (UTC). Format: ISO8601 e.g. 2016-01-12T11:08:23.

  Details

Array

Contains a list of elements keyed by item key. Each element contains new and original version of item properties.

    {Key}

Array

A variable field name containing the key of the item.

      Original

Array

Contains a list of the properties of the original item. Fields depend on the type of the item.

      New

Array

Contains a list of new/updated item properties of the original item. Fields depend on the type of the item.

  Summary

Array

Contains summary of the differences between two versions, grouped by the state (added, edited, unchanged and deleted).

    Added

Array

Contains a list of added item summaries.

      IsType

Boolean

Indicates whether the item is a type.

      IsCustom

Boolean

Indicates if the item is one of the custom types.

      Key

String

Key of the item.

      Type

String

Type of the item.

      TypeName

String

Human readable name of the type.

    Edited

Array

Contains a list of edited item summaries.

      IsType

Boolean

Indicates whether the item is a type.

      IsCustom

Boolean

Indicates if the item is one of the custom types.

      Key

String

Key of the item.

      Type

String

Type of the item.

      TypeName

String

Human readable name of the type.

    Unchanged

Array

Contains a list of unchanged item summaries.

      IsType

Boolean

Indicates whether the item is a type.

      IsCustom

Boolean

Indicates if the item is one of the custom types.

      Key

String

Key of the item.

      Type

String

Type of the item.

      TypeName

String

Human readable name of the type.

    Deleted

Array

Contains a list of deleted item summaries.

      IsType

Boolean

Indicates whether the item is a type.

      IsCustom

Boolean

Indicates if the item is one of the custom types.

      Key

String

Key of the item.

      Type

String

Type of the item.

      TypeName

String

Human readable name of the type.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

10111

CatalogVersionNotFound

Catalog Version does not exist.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Publish Catalog

Publish a new catalog version.

https://adminapi.chilliconnect.com/game/{token}/catalog/publish

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Commit optional

Boolean

A flag that if true, publishes the catalog. If false, shows the differences with the previous version. Defaults to false.

HTTP Status 200

Field Type Description
Difference with previous version

JSON

Provides a DiffSummary and DiffDetails from comparing the working copy with the last published version. DiffSummary lists the added, edited, deleted and unchanged items. DiffDetails provides more information on the changed items.

Catalog published

JSON

The new version details followed by the package URL.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

10110

LiveOpsConflicts

Invalid Request. The requested action is in conflict with a LiveOps instance. The Conflicts property of the response body will contain specific information on which items are in conflict.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Import Catalog

Import a catalog of items into the economy. The body content-type must be multipart/form-data. Can also provide information about the differences between the imported catalog and the working copy.

https://adminapi.chilliconnect.com/game/{token}/catalog/import

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Content-Type

String

The body content type must be multipart/form-data.

Body Parameter

Field Type Description
ZipPackage

Zip File

The catalog zip file to upload.

Commit optional

Boolean

A flag that if true, publishes the catalog. If false, shows the differences with the previous version. Defaults to false.

HTTP Status 200

Field Type Description
Response

JSON

Provides a Success and Committed flags. Also returns the Imported, Diff and Conflicts data after comparing the imported catalog with the current one. Success indicates if there are any issues with the import. Committed indicates if the import is completed. Imported lists the new, updated, removed and unchanged items, while Diff provides more information on the changed items. Conflicts list the items in conflict with LiveOps instances.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Get Catalog Items

Get items from the catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/items

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

URL Parameter

Field Type Description
Version optional

Integer

If not given the working copy set of items will be returned. Otherwise is a version as returned from the GetCatalogVersions endpoint, and will return items in that published version.

Offset optional

Integer

The number of items to skip before retrieving items.

Limit optional

Integer

The number of items to return (default/max is 20).

Keys optional

Array

Filter items by keys.

Note: to pass an array in a request the parameter is formatted as Keys[]=first.

KeyContains optional

String

Filter item keys with search term

Types optional

Array

Filter items by types.

Note: to pass an array in a request the parameter is formatted as Types[]=first.

Tags optional

Array

Filter items by tags.

Note: to pass an array in a request the parameter is formatted as Tags[]=first.

TagType optional

String

Values; ANY, ALL. When ALL an item will be included only if it has all of the Tags specified in the request. When ANY, any matched Tag will cause the item to be included.

HTTP Status 200

Field Type Description
Response

JSON

Version details followed by the list of retrieved catalog items. Items are paged with a default and max value of 20 items per page.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

10111

CatalogVersionNotFound

Catalog Version does not exist.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Currency

Add a Currency catalog item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be CURRENCY.

Name

String

The name of the currency.

Key

String

The key of the currency.

Tags optional

Array

The property tags given to the currency.

CustomData optional

JSON

The custom variables assigned to the currency.

Initial optional

Integer

The initial quantity allocation of a currency. Must be greater than or equal to 0.

Max optional

Integer

The max quantity allocation of a currency. Must be greater than or equal to 0.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Currency Conversion

Add a Currency Conversion catalog item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be CONVERSION.

Name

String

The name of the currency conversion.

Key

String

The key of the currency conversion.

Tags optional

Array

The property tags given to the currency conversion.

CustomData optional

JSON

The custom variables assigned to the currency conversion.

Rules

Array

An array of rules defining the conversion. Can have more than one rule per currency conversion. A Currency can be used more than once in a single Currency Conversion.

  CurrencyFromEconomyItemKey

String

The conversion from Currency.

  AmountFrom

Integer

The from amount.

  CurrencyToEconomyItemKey

String

The conversion to Currency.

  AmountTo

Integer

The to amount.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Inventory Item

Add an Inventory Item catalog item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be INVENTORYITEM.

Name

String

The name of the inventory item.

Key

String

The key of the inventory item.

Tags optional

Array

The property tags given to the inventory item.

CustomData optional

JSON

The custom variables assigned to the inventory item.

InitialAllocation optional

Integer

The initial quantity allocation of the inventory item. Must be greater than or equal to 0.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Virtual Purchase

Add a Virtual Purchase catalog item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be VIRTUALPURCHASE.

Name

String

The name of the virtual purchase.

Key

String

The key of the virtual purchase.

Tags optional

Array

The property tags given to the virtual purchase.

CustomData optional

JSON

The custom variables assigned to the virtual purchase.

Costs optional

Array

The costs for making a virtual purchase. Can have more than one cost per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

Rewards

Array

The rewards for making a virtual purchase. Can have more than one reward per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

OneTimePurchase

Boolean

Flag determining if the virtual purchase is a one-time event.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Real Money Purchase

Add a Real Money Purchase catalog item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be MONEYPURCHASE.

Name

String

The name of the real money purchase.

Key

String

The key of the real money purchase.

Tags optional

Array

The property tags given to the real money purchase.

CustomData optional

JSON

The custom variables assigned to the real money purchase.

IosID optional

String

iOS account ID used when making a real money purchase. At least one store ID is required.

GoogleID optional

String

Google account ID used when making a real money purchase. At least one store ID is required.

AmazonID optional

String

Amazon account ID used when making a real money purchase. At least one store ID is required.

Rewards

Array

The rewards for making a real money purchase. Can have more than one reward per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

OneTimePurchase

Boolean

Flag determining if the real money purchase is a one-time event.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Metadata

Add a Metadata item to the game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be METADATA.

Name

String

The name of the metadata.

Key

String

The key of the metadata.

Tags optional

Array

The property tags given to the metadata.

CustomData optional

JSON

The custom variables assigned to the metadata.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Zip Package

Add a Zip Package to a game's catalog.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Content-Type

String

Must be multipart/form-data.

Body Parameter

Field Type Description
Type

String

Must be ZIPPACKAGE

Name

String

The name of the zip package.

Key

String

The key of the zip package.

Tags optional

Array

The property tags given to the zip package.

Note: to pass an array in a request the parameter is formatted as Tags[]=first.

CustomData optional

JSON

The custom variables assigned to the zip package.

ZipPackage

Zip File

The zip file to upload.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1004

InvalidContentType

Content-type must be multipart/form-data.

1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Custom Type Item

Add an item from one of the defined custom types.

https://adminapi.chilliconnect.com/game/{token}/catalog/item

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Type

String

Must be the key of the custom type.

Name

String

The name of the custom type item.

Key

String

The key of the custom type item.

Tags optional

Array

The property tags given to the custom type item.

CustomData optional

JSON

The custom variables assigned to the custom type item.

Data

JSON

The attributes of the defined custom item type.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 409

Code Title Errors
10107

CatalogItemExistsAsOverride

Key exists in overrides.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

10101

CatalogItemExists

Key exists in overrides.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Currency

Edit a Currency catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/CURRENCY/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the currency.

Tags optional

Array

The property tags given to the currency.

CustomData optional

JSON

The custom variables assigned to the currency.

Initial optional

Integer

The initial quantity allocation of a currency. Must be greater than or equal to 0.

Max optional

Integer

The max quantity allocation of a currency. Must be greater than or equal to 0.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Currency Conversion

Edit a Currency Conversion catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/CONVERSION/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the currency conversion.

Tags optional

Array

The property tags given to the currency conversion.

CustomData optional

JSON

The custom variables assigned to the currency conversion.

Rules

Array

An array of rules defining the conversion. Can have more than one rule per currency conversion. A Currency can be used more than once in a single Currency Conversion.

  CurrencyFromEconomyItemKey

String

The conversion from Currency.

  AmountFrom

Integer

The from amount.

  CurrencyToEconomyItemKey

String

The conversion to Currency.

  AmountTo

Integer

The to amount.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Inventory Item

Edit an Inventory Item catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/INVENTORYITEM/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the inventory item.

Tags optional

Array

The property tags given to the inventory item.

CustomData optional

JSON

The custom variables assigned to the inventory item.

InitialAllocation optional

Integer

The initial quantity allocation of the inventory item. Must be greater than or equal to 0.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Virtual Purchase

Edit a Virtual Purchase catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/VIRTUALPURCHASE/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the virtual purchase.

Tags optional

Array

The property tags given to the virtual purchase.

CustomData optional

JSON

The custom variables assigned to the virtual purchase.

Costs optional

Array

The costs for making a virtual purchase. Can have more than one cost per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

Rewards

Array

The rewards for making a virtual purchase. Can have more than one reward per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

OneTimePurchase

Boolean

Flag determining if the virtual purchase is a one-time event.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Real Money Purchase

Edit a Real Money Purchase catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/MONEYPURCHASE/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the real money purchase.

Tags optional

Array

The property tags given to the real money purchase.

CustomData optional

JSON

The custom variables assigned to the real money purchase.

IosID optional

String

iOS account ID used when making a real money purchase. At least one store ID is required.

GoogleID optional

String

Google account ID used when making a real money purchase. At least one store ID is required.

AmazonID optional

String

Amazon account ID used when making a real money purchase. At least one store ID is required.

Rewards

Array

The rewards for making a real money purchase. Can have more than one reward per purchase. An economy item can be used more than once.

  EconomyItemKey

String

The Key of the item used in the exchange.

  Amount

Integer

The amount of items issued as a reward.

OneTimePurchase

Boolean

Flag determining if the real money purchase is a one-time event.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Metadata

Edit a Metadata catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/METADATA/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the metadata.

Tags optional

Array

The property tags given to the metadata.

CustomData optional

JSON

The custom variables assigned to the metadata.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Zip Package

Edit a Zip Package catalog item.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/ZIPPACKAGE/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Content-Type

String

Must be multipart/form-data.

Body Parameter

Field Type Description
Name

String

The name of the zip package.

Tags optional

Array

The property tags given to the zip package.

Note: to pass an array in a request the parameter is formatted as Tags[]=first.

CustomData optional

JSON

The custom variables assigned to the zip package.

ZipPackage

Zip File

The zip file to upload.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1004

InvalidContentType

Content-type must be multipart/form-data.

1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Custom Type Item

Edit an item from one of the defined custom types. Note that {type} parameter in the URL must be replaced with the key of the custom type.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/{type}/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

Body Parameter

Field Type Description
Name

String

The name of the custom type item.

Tags optional

Array

The property tags given to the custom type item.

CustomData optional

JSON

The custom variables assigned to the custom type item.

Data

JSON

The attributes of the defined custom item type.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Delete Catalog Item

Delete a catalog item from the economy.

https://adminapi.chilliconnect.com/game/{token}/catalog/item/{type}/{key}

Header

Field Type Description
Api-Token

String

The valid token of the API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

The version of the API to call.

URL Parameter

Field Type Description
Type

String

The type of catalog item to delete.

Key

String

The key of the catalog item to delete.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

10103

CatalogItemNotFound

Catalog Item Not Found.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

10104

CatalogItemInUse

Catalog item cannot be deleted as it is referenced by other items.

10108

CatalogItemInUseInOverride

Catalog item cannot be deleted as it is referenced by other items.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Cloud Code

Metrics

The ChillConnect Admin API Metrics module. Provides the means to retrieve information surrounding metrics and analytics.

Get Exports

Get the Bar-Delimited Value formatted data exports that we hold in our warehouse for a certain Date.

https://adminapi.chilliconnect.com/game/{token}/analytics/exports

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

URL Parameter

Field Type Description
Date optional

String

The requested date of the Exports. Defaults to yesterdays date. Format: YYYY-MM-DD.

HTTP Status 200

Field Type Description
Exports

Array

A list of Data Exports for the requested Date.

  {Export}

Array

Name of the Export type. Can be one of Events, Sessions, SessionSegments, Purchases, Installs, KPIs, EventTypes, EventTypeParams. Note if there is no data for the Export type it will be absent from this list.

    Url

String

URL of the file, can be used to download the Metrics Export. Please note these links expire within an hour of being generated so you will need to call this endpoint again to regenerate the URLs with a new Expiry.

    Filename

String

The name of the file that is being referenced.

    PartNumber

Integer

The files are split into Parts. This variable denotes which part number this file is.

    FileSize

Integer

The size of the file part in Bytes.

Date

String

The Date of the returned Data Export. Format: YYYY-MM-DD.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Get Definitions

Definitions detailing the data contents of each file returned in the GetExports endpoint.

https://adminapi.chilliconnect.com/game/{token}/analytics/definitions/exports

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

HTTP Status 200

Field Type Description
ExportDefinitions

Array

A list detailing each of columns contained in the Exports.

  {Export}

Array

Definition of the data contained in each Export.

    Name

String

Reference name of the column for use of the client accessing the Export.

    Type

String

Type of data contained within the column. Although always a string in the Export files itself, can be safely typecast to one of the following: String, Int, Date, DateTime, Decimal.

    Description

String

Description of what the data in that particular column is.

    Example

String

An Example of what may be contained in that column.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Cloud Code

The ChillConnect Admin API Script module. Provides the means to retrieve and manipulate scripts.

Add External Script

Add External script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be EXTERNAL.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Photon Callback Script

Add PhotonCallback script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be PHOTONCALLBACK.

Code optional

String

When provided, the code must contain valid JavaScript.

PhotonCallbackType

String

Possible values: PATH.CLOSE, PATH.CREATE, PATH.EVENT, PATH.GAME.PROPERTIES, PATH.JOIN, PATH.LEAVE

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Schedule Script Hourly

Add Schedule script for running hourly in UTC.

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be HOURLY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Schedule Script Daily

Add Schedule script for running daily in UTC.

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be DAILY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

ScheduleHour

Integer

Hour value for schedule. Possible values from range: 0-23. No proceeding '0' (e.g. '06') allowed.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Schedule Script Weekly

Add Schedule script for running weekly in UTC.

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be WEEKLY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

ScheduleHour

Integer

Hour value for schedule. Possible values from range: 0-23. No proceeding '0' (e.g. '06') allowed.

ScheduleDayOfWeek

String

Day value for schedule. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Module Script

Add Module script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be MODULE.

Code optional

String

When provided, must contain valid JavaScript or C# code.

Language

String

Possible values: JS, CS

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Api Script

Add API script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be API.

Code optional

String

When provided, the code must contain valid JavaScript.

Params optional

Array

An array of maximum 10 elements containing list of parameter objects

  Name

String

Parameter name

  Type optional

String

Possible values: STRING, NUMERIC, BOOL, JSON, ANY. Default value: ANY

  Required optional

Boolean

Value used for validating requests to the run script calls. Default value: false

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9005

InvalidScriptParameters

Invalid Parameters For Script. One of more script parameters failed validation. The data property of the error contains details of the specfic errors.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Event Script

Add Event script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be EVENT.

EventType

String

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9003

ScriptKeyExists

Script Key Already Exists.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Add Support Script

Add Support script

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Key

String

The key of the script.

Name

String

The name of the script.

Type

String

Must be SUPPORT.

Code optional

String

When provided, the code must contain valid JavaScript.

Params optional

Array

An array of maximum 10 elements containing list of parameter objects

  Name

String

Parameter name

  Type optional

String

Possible values: STRING, NUMERIC, BOOL, JSON, ANY. Default value: ANY

  Required optional

Boolean

Value used for validating requests to the run script calls. Default value: false

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9003

ScriptKeyExists

Script Key Already Exists.

9005

InvalidScriptParameters

Invalid Parameters For Script. One of more script parameters failed validation. The data property of the error contains details of the specfic errors.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Api Script

Edit API script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be API.

Code optional

String

When provided, the code must contain valid JavaScript.

Params optional

Array

An array of maximum 10 elements containing list of parameter objects

  Name

String

Parameter name

  Type optional

String

Possible values: STRING, NUMERIC, BOOL, JSON, ANY. Default value: ANY

  Required optional

Boolean

Value used for validating requests to the run script calls. Default value: false

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9005

InvalidScriptParameters

Invalid Parameters For Script. One of more script parameters failed validation. The data property of the error contains details of the specfic errors.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Support Script

Edit Support script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be SUPPORT.

Code optional

String

When provided, the code must contain valid JavaScript.

Params optional

Array

An array of maximum 10 elements containing list of parameter objects

  Name

String

Parameter name

  Type optional

String

Possible values: STRING, NUMERIC, BOOL, JSON, ANY. Default value: ANY

  Required optional

Boolean

Value used for validating requests to the run script calls. Default value: false

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9005

InvalidScriptParameters

Invalid Parameters For Script. One of more script parameters failed validation. The data property of the error contains details of the specfic errors.

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Schedule Script Hourly

Edit Schedule script for running hourly in UTC.

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be HOURLY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Schedule Script Daily

Edit Schedule script for running daily in UTC.

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be DAILY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

ScheduleHour

Integer

Hour value for schedule. Possible values from range: 0-23. No proceeding '0' (e.g. '06') allowed.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Schedule Script Weekly

Edit Schedule script for running weekly in UTC.

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be SCHEDULE.

ScheduleType

String

Must be WEEKLY

ScheduleMinute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

ScheduleHour

Integer

Hour value for schedule. Possible values from range: 0-23. No proceeding '0' (e.g. '06') allowed.

ScheduleDayOfWeek

String

Day value for schedule. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Event Script

Edit Event script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be EVENT.

EventType

String

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit External Script

Edit External script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be EXTERNAL.

Code optional

String

When provided, the code must contain valid JavaScript.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Module Script

Edit Module script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be MODULE.

Code optional

String

When provided, must contain valid JavaScript or C# code.

Language

String

Possible values: JS, CS

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Edit Photon Callback Script

Edit PhotonCallback script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Name

String

The name of the script.

Type

String

Must be PHOTONCALLBACK.

Code optional

String

When provided, the code must contain valid JavaScript.

PhotonCallbackType

String

Possible values: PATH.CLOSE, PATH.CREATE, PATH.EVENT, PATH.GAME.PROPERTIES, PATH.JOIN, PATH.LEAVE

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

9008

ScriptCompilationException

Compilation error. Returns error message returned by the compiler.

9012

ScriptEditTypeMismatch

Mismatching types. Script cannot change type.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Get Script Details

Get Script Details

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

URL Parameter

Field Type Description
Version optional

Integer

Version of the requested script. Default: working copy.

HTTP Status 200

Field Type Description
Name

String

The name of the script.

Key

String

The key of the script.

Type

String

The type of the script.

Language

String

The language of the script. Possible values: JS, CS.

PublishedVersion

String

Currently published version of the script. Null for working copy of the script.

DatePublished

String

Publish date of the most recently published version. Format: ISO8601 e.g. 2016-01-12T11:08:23. Null for working copy of the script.

Versions

Array

An array of published versions.

  Version

String

Version identifier.

  DatePublished

String

Publish date (UTC) of each version. Format: ISO8601 e.g. 2016-01-12T11:08:23.

Script

Object

Code and version of the requested script.

  Version

String

Version identifier for the script. Reflects requested version of the script. When no Version parameter passed, this value will be null to represent the working copy of the script.

  Code

String

Script code.

  DateUpdate

String

For unpublished scripts date of the last update. For published version, version publish date. Format: ISO8601 e.g. 2016-01-12T11:08:23.

PhotonCallback

Object

Fields relevant to Photoncallback scripts.

  Type

String

Type of Photoncallback script.

  Name

String

Human readable type of Photoncallback script.

Event

Object

Fields relevant to Event scripts.

  Type

String

Type of Event script.

  Name

String

Human readable type of Event script.

Schedule

Object

Fields relevant to Schedule scripts.

  Type

String

Type of Event script.

  Name

String

Human readable type of Event script.

  RunSchedule

Object

Data required for running schedules script

    Type

String

Type of Schedule script.

    Minute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

    Hour

Integer

Hour value for schedule. Possible values from range: 0-23. No proceeding '0' (e.g. '06') allowed.

    DayOfWeek

String

Day value for schedule. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

  DateLastRunStart

String

Start of the last run of the script.

  DateLastRunEnd

String

End of the last run of the script.

  DateNextRunStart

String

Date of when the script is scheduled to be run.

ScriptParameters

Array

Script parameters.

  Name

String

Parameter name

  Type

String

Possible values: STRING, NUMERIC, BOOL, JSON, ANY. Default value: ANY

  Required

Boolean

Value used for validating requests to the run script calls. Default value: false

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
9013

ScriptVersionNotFound

Script Version Not Found

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

List Scripts

Get paged and optionally filtered by type list of scripts.

https://adminapi.chilliconnect.com/game/{token}/script

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

URL Parameter

Field Type Description
Type optional

String

Type of the script. Possible values API, SUPPORT, EVENT, SCHEDULE, PHOTONCALLBACK, MODULE, EXTERNAL

Offset optional

Integer

The number of results to skip at the beginning. For example, if the total number of results that are returned is 10, and the offset is 8, it returns the last two results. The default is 0.

HTTP Status 200

Field Type Description
Total

Integer

Number of found scripts.

Offset

Integer

The number of results to skip at the beginning. For example, if the total number of results that are returned is 10, and the offset is 8, it returns the last two results.

Limit

Integer

The number of items to return (default/max is 20).

Scripts

Array

  Type

Object

Type of the script. Possible values API, SUPPORT, EVENT, SCHEDULE, PHOTONCALLBACK, MODULE, EXTERNAL

    Type

String

Type of script.

    Name

String

Human readable type of script.

  Name

String

Name of the script.

  Key

String

Key of the script.

  Language

String

Language of the script. Possible values: JS, CS (available only for Module Scripts).

  Published

Boolean

The value shows if the script is published.

  LastPublishedDate

String

Date of publishing the most recent version of the script. Format: ISO8601 e.g. 2016-01-12T11:08:23. Null if the script is not published.

  LastPublishedVersion

String

Identifier of the most recently published version of the script. Null if the script is not published.

  Schedule

Object

Fields available for SCHEDULE scripts.

    Type

String

Must be either: HOURLY, DAILY or WEEKLY

    Minute

Integer

Minute value for schedule. Possible values from range: 0-59. No proceeding '0' (e.g. '06') allowed.

    Hour

Integer

Hour value for schedule. Possible values from range: 0-23. Relevant to DAILY and WEEKLY ScheduleTypes.

    DayOfWeek

String

Day value for schedule. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN. Relevant to WEEKLY ScheduleType.

  EventType

Object

Field available for EVENT scripts.

    Type

String

Type of Event script.

    Name

String

Human readable type of Event script.

  PhotonCallbackType

Object

Fields available for PHOTONCALLBACK scripts.

    Type

String

Type of Photoncallback script.

    Name

String

Human readable type of Photoncallback script.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Publish Script

Publish script

https://adminapi.chilliconnect.com/game/{token}/script/{key}/publish

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

HTTP Status 200

Field Type Description
Version

String

Identifier of the newly created version.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

InvalidRequest

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

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

HTTP Status 503

Code Title Errors
1008

TemporaryServiceError

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

Test Run Api Script

Test run API script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
ChilliConnectId

String

Player ID.

StartMetricsSession optional

Boolean

True if a Metrics Session should be started for the Script run. Some Script SDK calls require a Metrics Session to be in progress. Default: false.

Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

Params optional

Object

Object containing Key-Value (String - MultiTypeValue) pairs that map on to the parameter definitions for the event. Parameters are required accordingly to the definition. Possible data types for values: STRING, NUMERIC, BOOL, JSON, ANY.

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Test Run Support Script

Test run Support script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
ChilliConnectId

String

Player ID.

Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Test Run Scheduled Script

Test run Scheduled script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Test Run Event Script

Test run Event script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

ChilliConnectId optional

String

Player ID.

StartMetricsSession optional

Boolean

True if a Metrics Session should be started for the Script run. Some Script SDK calls require a Metrics Session to be in progress. Default: false.

Request optional

JSON

Data from the request triggering the Event Script. Further information available here: Cloude Code - Event Script

Response optional

JSON

Data from the request triggering the Event Script. Further information available here: Cloude Code - Event Script

EventData optional

JSON

Data from the request triggering the Event Script. Further information available here: Cloude Code - Event Script

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Examples

//Simulating the AddScore API Call Event: API.LB.ADDSCORE
{
	"ChilliConnectID": "sampleChilliConnectID",
	"StartMetricsSession": false,
    //Request is JSON object of the Parameters of the API call
	"Request": {"Score":10, "Key":"LEADERBOARD_KEY"},
    //Response is JSON object of the response of the API call
	"Response": {"Data":null, "Score":5, "GlobalRank":1, "GlobalTotal": 5}
}
//Simulating the Match WaitingTimeout Event: ASYNCMULTIPLAYER.MATCH.WAITINGTIMEDOUT
{
	"EventData": {"MatchId": "sampleID"}
}

Test Run External Script

Test run External script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Method

String

Request method. Possible values: POST, GET, PUT, DELETE, PATCH

Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

PostFields optional

Object

Object containing Key-Value (String-MultiTypeValue) pairs that represent post parameters for the external script request. For further information reference: Cloud Code - External Scripts

Note: Contents of the field are used only when Body is not provided in the request. Otherwise, the field is ignored.

UrlParams optional

Object

Object containing Key-Value (String-MultiTypeValue) pairs that represent query parameters for the external script URL. For further information reference: Cloud Code- External Scripts

Headers optional

Object

Object containing Key-Value (String-MultiTypeValue) pairs that represent request headers for the external script URL. For further information reference: Cloud Code - External Scripts

Body optional

String

Body of the request.

Note: When this field is provided, contents of the PostFields are ignored.

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

9201

ExternalScriptResponseInvalidStatusCode

The External Script Response HTTP status code { ResponseCode } is not valid.

9202

ExternalScriptResponseInvalidHeaders

The External Script Response headers are invalid.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Test Run Photon Callback Script

Test run PhotonCallback script.

https://adminapi.chilliconnect.com/game/{token}/script/{key}/run

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

Body Parameter

Field Type Description
Version optional

String

Version identifier. By default the working copy (identified by null) of the script is run.

ChilliConnectId optional

String

Player ID.

PhotonCallbackData optional

Object

Object containing Key-Value (String-MultiTypeValue) pairs that represent properties specific to PhotonCallback. For further information reference: Cloud Code- PhotonCallback Scripts

HTTP Status 200

Field Type Description
Output

JSON

Content returned from the script.

Logs

Array

Script logs generated using ChilliConnectScript Logger. For further information reference: Cloud Code - Logging

  Key

String

Script Key.

  Version

String

Script version. Null for working copy of the script.

  Date

String

Date when the log was created. Format: ISO8601 e.g. 2016-01-12T11:08:23.

  LogLevel

String

Log level defined in the Scripting API. Possible values: INFO, WARN, ERROR, DEBUG

  Message

JSON

Logged message.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 422

Code Title Errors
1007

UnprocessableEntity

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

1007

InvalidRequest

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

9002

ScriptException

Exception Occurred When Attempting to Run Script. The script could not be executed due to a runtime error.

9007

ScriptTimeout

Script Exceeded Maximum Execution Time

9014

ScriptNotSupportedForTestRun

Test Run For This Type Is Not Supported.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.

Delete Script

Delete Script

https://adminapi.chilliconnect.com/game/{token}/script/{key}

Header

Field Type Description
Api-Token

String

The token of a valid API user.

Api-Secret

String

The valid password of the API user.

Api-Version

String

API version to call.

HTTP Status 400

Code Title Errors
1007

BadRequest

Invalid Request. Required headers: Api-Token, Api-Secret, Api-Version.

HTTP Status 401

Code Title Errors
1005

Unauthorized

Invalid credentials.

9003

ScriptNotFound

Script Not Found. The specified script does not exist.

HTTP Status 404

Code Title Errors
1007

AppNotFound

The selected Application either doesn't exist or the API User doesn't have permissions to access it.

HTTP Status 500

Code Title Errors
1

Unexpected

Unexpected Error. An unexpected, fatal error has occurred.