purchase
purchase method of REST API is used to send the data about a user's game verified purchases. If the user has never logged the game in before, the new profile will be created for the user in Game of Whales.
Pay attention that by default Game of Whales doesn't make verification of purchases received through purchase method. All purchases (including refunds, restores, cheater's purchases) will increase the stats. So in order to have correct stats, a game developer should verify purchases on the game side and send the data only about legal purchases to Game of Whales system.
If it's needed to verify purchases on Game of Whales side, the special parameter verify should be set in purchase method or receipt method should be used. Game of Whales supports verification of purchases from Google Play, Apple App Store and Samsung Store only.
POST https://api.gameofwhales.com:8488/purchase
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: |
{ | |||
currency
|
required | string | A local currency code (USD, EUR, etc). |
price
|
required | number | A purchase's price in local currency multiplied by 100. Should be equal or more than 0.01. |
product
|
required | string | A purchased product's SKU. |
store
|
required | enum | Used store. Allowed values are "AmazonStore", "AppleAppStore", "Facebook", "GooglePlay", "HuaweiStore", "Kongregate", "MacAppStore", "Odnoklassniki", "SamsungApps", "SFRPixtel", "VK", "WindowsStore", "XiaomiStore", "Other". |
receipt
|
optional | string | A serialized purchase receipt. |
transactionId
|
optional | string | A purchase's transaction ID. |
at
|
optional | timestamp | The date of the event. If the argument isn't defined, the current date will be used. |
verify
|
optional | boolean | Defines whether to verify a purchase on Game of Whales side or not. Should be true to verify the purchase. If the argument is false or missing, the purchase will handle without verification. |
} |
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/purchase
REQUEST_JSON = {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "uwp", "store": "WindowsStore", "version": "1.0.0", "expId": "5d2effe09236b00e38e34c3b"},"event": {"transactionId":"1000000357435566", "currency":"USD", "price":105, "product": "product_1", "store": "WindowsStore"}}
An actual request with the example values:
curl -XPOST 'api.gameofwhales.com:8488/purchase' -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": "uwp", "store": "WindowsStore", "version": "1.0.0", "expId": "5d2effe09236b00e38e34c3b"},"event": {"transactionId":"1000000357435566", "currency":"USD", "price":105, "product": "product_1", "store": "WindowsStore"}} EOF
RESPONSE ARGUMENTS
Response argument | Required or optional | Type | Description |
---|---|---|---|
receipts | optional | object[] | The information about purchases. It includes the following properties: |
[ | |||
{ | |||
transaction
|
required | string | A purchase's transaction ID. |
verifyState
|
required | string |
The result of purchase validation. The value can be: "legal" - a purchase is legal. "illegal" - a purchase is a cheater's. "undefined" - the system couldn't verify a purchase. "bypass" - the system doesn't verify a purchase. "double" - the system has had purchase with the same transaction ID. |
} | |||
] | |||
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. |
adsEnabled
|
optional | boolean | A recommendation about a showing of ads. |
} | |||
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:
{ "receipts": [ { "transaction": "1000000357435566", "verifyState": "bypass" } ], "properties": { "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "group": "b", "revenue": 3 }, "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: |
{ | |||
currency
|
required | string | A local currency code (USD, EUR, etc). |
price
|
required | number | A purchase's price in local currency multiplied by 100. Should be equal or more than 0.01. |
product
|
required | string | A purchased product's SKU. |
store
|
required | enum | Used store. Allowed values are "AmazonStore", "AppleAppStore", "Facebook", "GooglePlay", "HuaweiStore", "Kongregate", "MacAppStore", "Odnoklassniki", "SamsungApps", "SFRPixtel", "VK", "WindowsStore", "XiaomiStore", "Other". |
receipt
|
optional | string | A serialized purchase receipt. |
transactionId
|
optional | string | A purchase's transaction ID. |
at
|
optional | timestamp | The date of the event. If the argument isn't defined, the current date will be used. |
verify
|
optional | boolean | Defines whether to verify a purchase on Game of Whales side or not. Should be true to verify the purchase. If the argument is false or missing, the purchase will handle without verification. |
} |
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/purchase
REQUEST_JSON = {"game": "$YOUR_GAME_KEY", "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "common": {"ip": "91.232.111.204", "locale": "en_EN", "platform": "uwp", "store": "WindowsStore", "version": "1.0.0"},"event": {"transactionId":"1000000357435566", "currency":"USD", "price":105, "product": "product_1", "store": "WindowsStore"}}
An actual request with the example values:
curl -XPOST 'api.gameofwhales.com:8488/purchase' -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": "uwp", "store": "WindowsStore", "version": "1.0.0"},"event": {"transactionId":"1000000357435566", "currency":"USD", "price":105, "product": "product_1", "store": "WindowsStore"}} EOF
RESPONSE ARGUMENTS
Response argument | Required or optional | Type | Description |
---|---|---|---|
receipts | optional | object[] | The information about purchases. It includes the following properties: |
[ | |||
{ | |||
transaction
|
required | string | A purchase's transaction ID. |
verifyState
|
required | string |
The result of purchase validation. The value can be: "legal" - a purchase is legal. "illegal" - a purchase is a cheater's. "undefined" - the system couldn't verify a purchase. "bypass" - the system doesn't verify a purchase. "double" - the system has had purchase with the same transaction ID. |
} | |||
] | |||
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. |
adsEnabled
|
optional | boolean | A recommendation about a showing of ads. |
} | |||
serverTime | required | timestamp | The current time of Game of Whales server. |
An example of a response:
{ "receipts": [ { "transaction": "1000000357435566", "verifyState": "bypass" } ], "properties": { "user": "3A15982E-C4CB-0000-0000-D88861BA0C49", "group": "b", "revenue": 3 }, "serverTime": 1545381287159 }