acquire
acquire method of REST API is an additional method to send information that the user acquired the resources. It is convenient to use in the case when the user spent one unit of the resource for the acquisition of some amount of another resource (for example, he spent 1 item1 to acquire 100 coins). In order to reflect more complicated cases of resource converting (for example, the user spent 2 items to acquire 1 bike and 100 coins) converting method should be called.
If the user has never logged the game in before the calling of acquire method, the new profile will be created for the user in Game of Whales.
POST https://api.gameofwhales.com:8488/acquire
version 2.2.0
version 2.1.0
version 2.0.0
version 1.0.0
version 2.2.0
There are no differences from version 2.0.0
version 2.1.0
There are no differences from version 2.0.0.
version 2.0.0
REQUEST ARGUMENTS
Arguments are in JSON format with the Content-Type application/json.
Request argument | Required or optional | Type | Description |
---|---|---|---|
game | required | string | Game key. |
user | required | string | User’s ID. Any string can be used, but it should be unique for each user. |
common | required | object | Common information about the user. The object includes the following parameters: |
{ | |||
ip
|
optional | string | User's IP. It's used to define country, timezone, timezone offset, weather. If the argument is not set, "country" argument should be defined. |
country
|
optional | string | Code of the user's country. It's required if "ip" parameter is not defined. If "ip" is set, "country" argument will be ignored. The list of supporting countries is here. |
locale
|
required | string | User's device's locale defined by RFC 1766. It's used to select the language of push notifications. |
platform
|
required | enum | User's device's platform. Allowed values are "android", "ios", "macosx", "uwp", "web". |
store
|
required | enum | Used store. Allowed values are "AmazonStore", "AppleAppStore", "Facebook", "GooglePlay", "HuaweiStore", "Kongregate", "MacAppStore", "Odnoklassniki", "SamsungApps", "SFRPixtel", "VK", "WindowsStore", "XiaomiStore", "Other". |
version
|
required | string | User's application version. |
expId
|
optional | string | ID of A/B testing experiment. Should be sent as a confirmation of the user's participation in the experiment. |
} | |||
event | required | object | Additional information about the event. Should contain the following arguments: |
{ | |||
amount
|
required | number | The amount of acquired resource. |
currency
|
required | string | In-game or in-app product identifier (it's sku for in-app products) of an acquired resource. |
source
|
required | string | In-game or in-app product identifier (it's sku for in-app products) of a consumed resource. |
at
|
optional | timestamp | The date of the event. If the argument isn't defined, the current date will be used. |
place
|
optional | string | The place where the operation was made. |
} |
A template for a request using cURL on the command line:
curl -XPOST $URL -H 'Accept-Version: 2.0.0' -H 'Content-Type: application/json' -d @- << EOF $REQUEST_JSON EOF
An example values:
URL = api.gameofwhales.com:8488/acquire
REQUEST_JSON = {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "ios", "store": "AppleAppStore", "version": "1.0.0", "expId": "5d2effe09236b00e38e34c3b"},"event": {"amount": 100, "currency": "coins", "source": "item1", "place": "shop"}}
An actual request with the example values:
curl -XPOST 'api.gameofwhales.com:8488/acquire' -H 'Accept-Version: 2.0.0' -H 'Content-Type: application/json' -H 'Content-Type: application/json' -d @- << EOF {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "ios", "store": "AppleAppStore", "version": "1.0.0", "expId": "5d2effe09236b00e38e34c3b"},"event": {"amount": 100, "currency": "coins", "source": "item1", "place": "shop"}} EOF
RESPONSE ARGUMENTS
Response argument | Required or optional | Type | Description |
---|---|---|---|
properties | required | object | User's properties. The object includes the following properties: |
{ | |||
user
|
required | string | User’s ID. |
group
|
required | string | User's group. The property is used for analyzing of push and special offer campaigns. |
revenue
|
required | number | The current amount of the user's purchases. |
custom property
|
optional | string, boolean, object | Additional custom properties. They are returned only if they are defined on Game of Whales side. |
} | |||
experiment | optional | object | The data about A/B testing experiment in which the user was included. The object isn't returned if the user doesn't take part in any experiment. |
{ | |||
id
|
required | string | ID of the experiment. |
key
|
required | string | String-key of the experiment. |
groupKey
|
required | string | Experiment's group in which the user was included. |
payload
|
optional | string | Payload for the experiment's group. |
signature
|
required | string | Encrypted data about the experiment. It can be used to verify the experiment on the game server side. |
} | |||
serverTime | required | timestamp | The current time of Game of Whales server. |
An example of a response:
{ "properties": { "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "group": "b", "revenue": 2, "boolTestField": true, "stringArrayTestField": [ "test", "test2" ], "objectTestField": { "key1": "value1", "key2": 100, "key3": 100.4, "key4": true } }, "experiment": { "id": "5d2effe09236b00e38e34c3b", "key": "exp_cr", "groupKey": "B", "payload": "{\"btnColor\": \"grean\", \"btnSize\": \"big\"}", "signature": "f6c66c70f459b13..." }, "serverTime": 1545296120344 }
version 1.0.0
REQUEST ARGUMENTS
Arguments are in JSON format with the Content-Type application/json.
Request argument | Required or optional | Type | Description |
---|---|---|---|
game | required | string | Game key. |
user | required | string | User’s ID. Any string can be used, but it should be unique for each user. |
common | required | object | Common information about the user. The object includes the following parameters: |
{ | |||
ip
|
optional | string | User's IP. It's used to define country, timezone, timezone offset, weather. If the argument is not set, "country" argument should be defined. |
country
|
optional | string | Code of the user's country. It's required if "ip" parameter is not defined. If "ip" is set, "country" argument will be ignored. The list of supporting countries is here. |
locale
|
required | string | User's device's locale defined by RFC 1766. It's used to select the language of push notifications. |
platform
|
required | enum | User's device's platform. Allowed values are "android", "ios", "macosx", "uwp", "web". |
store
|
required | enum | Used store. Allowed values are "AmazonStore", "AppleAppStore", "Facebook", "GooglePlay", "HuaweiStore", "Kongregate", "MacAppStore", "Odnoklassniki", "SamsungApps", "SFRPixtel", "VK", "WindowsStore", "XiaomiStore", "Other". |
version
|
required | string | User's application version. |
} | |||
event | required | object | Additional information about the event. Should contain the following arguments: |
{ | |||
amount
|
required | number | The amount of acquired resource. |
currency
|
required | string | In-game or in-app product identifier (it's sku for in-app products) of an acquired resource. |
source
|
required | string | In-game or in-app product identifier (it's sku for in-app products) of a consumed resource. |
at
|
optional | timestamp | The date of the event. If the argument isn't defined, the current date will be used. |
place
|
optional | string | The place where the operation was made. |
} |
A template for a request using cURL on the command line:
curl -XPOST $URL -H 'Accept-Version: 1.0.0' -H 'Content-Type: application/json' -d @- << EOF $REQUEST_JSON EOF
An example values:
URL = api.gameofwhales.com:8488/acquire
REQUEST_JSON = {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "ios", "store": "AppleAppStore", "version": "1.0.0"},"event": {"amount": 100, "currency": "coins", "source": "item1", "place": "shop"}}
An actual request with the example values:
curl -XPOST 'api.gameofwhales.com:8488/acquire' -H 'Accept-Version: 1.0.0' -H 'Content-Type: application/json' -H 'Content-Type: application/json' -d @- << EOF {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "ios", "store": "AppleAppStore", "version": "1.0.0"},"event": {"amount": 100, "currency": "coins", "source": "item1", "place": "shop"}} EOF
RESPONSE ARGUMENTS
Response argument | Required or optional | Type | Description |
---|---|---|---|
properties | required | object | User's properties. The object includes the following properties: |
{ | |||
user
|
required | string | User’s ID. |
group
|
required | string | User's group. The property is used for analyzing of push and special offer campaigns. |
revenue
|
required | number | The current amount of the user's purchases. |
custom property
|
optional | string, boolean, object | Additional custom properties. They are returned only if they are defined on Game of Whales side. |
} | |||
serverTime | required | timestamp | The current time of Game of Whales server. |
An example of a response:
{ "properties": { "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "group": "b", "revenue": 2, "boolTestField": true, "stringArrayTestField": [ "test", "test2" ], "objectTestField": { "key1": "value1", "key2": 100, "key3": 100.4, "key4": true } }, "serverTime": 1545296120344 }