Sync Operators and Brands
Automatically synchronizes all operators and brands between the client’s system and Gamity. Using this endpoint is optional and only necessary if the client has a lot of frequently changing operators and brands, such as multiple brick-and-mortar locations, kiosks, etc. Most clients only have a few brands. In this case, the brands are manually set up.
The entire relevant operator and brand portfolio should be sent in this call, which will merge with the existing operators and brands in Gamity. New operators and brands will be added, operators and brands missing in the client’s system but existing in Gamity will be disabled, and existing operators and brands will be updated.
Interactive swagger page (under the “External” group): Swagger UI
Example request
POST https://qa-ec1.transaction-api.gamity.io/external/{INTEGRATION_ID}/sync-operators-and-brands
Content-Type: application/json
X-API-Key: {ask from Codemodity}
[
{
"ref": "operator-1",
"name": "Operator 1",
"brands": [
{
"ref": "brand-1",
"name": "Brand 1"
},
{
"ref": "brand-2",
"name": "Brand 2"
}
]
},
{
"ref": "operator-2",
"name": "Operator 2",
"brands": [
{
"ref": "brand-3",
"name": "Brand 3"
},
{
"ref": "brand-4",
"name": "Brand 4"
}
]
}
]Request parameters
The request body must be an array of operators, each containing an array of brands.
Operator
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| ref | string | Yes | Unique identifier for the operator. No specific format is required, but it must be a maximum of 100 characters in length. | |
| name | string | Yes | Display name of the operator shown in the backoffice UI. This name is not translated and will appear the same across all languages. | |
| brands | Brand[] | Yes | List of brands associated with the operator. |
Brand
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| ref | string | Yes | Unique identifier for the brand. No specific format is required, but it must be a maximum of 100 characters in length. | |
| name | string | Yes | Display name of the brand shown in both the backoffice and player-facing UIs. This name is not translated and will appear the same across all languages. |
Response codes
| HTTP Status Code | Description |
|---|---|
| 200 | OK - The request was successfully processed. The operator and brand information has been synchronized as expected. |
| 400 | Bad Request - The request was invalid. This can occur due to missing required parameters, incorrect parameter types, or malformed request data. |
| 401 | Unauthorized - The API key is missing or invalid. |