Get campaign capabilities

What each provider supports

GET/v1/campaigns/capabilities

Request

A client sends this request signed with its credential. The example is signed with the test API key test-key-test-key and the test secret docs-example-signing, at the timestamp 1767225600 with the nonce docs-example-nonce-0001; see Authentication and signing.

Headers

Name
X-Api-Key
Type
string, required
Description
The credential id. Sent together with X-Timestamp, X-Nonce and X-Signature.
Name
X-Signature
Type
string, required
Description
Base64 HMAC-SHA256 of the method, the path with its query, X-Timestamp, X-Nonce and the lowercase hex SHA-256 of the raw body, joined by newlines. Compared in constant time; 30 seconds of tolerance; each nonce is used once.
Name
X-Timestamp
Type
string, required
Description
Unix seconds; within 30 seconds of the receiver's clock. Matches ^[0-9]{1,12}$.
Name
X-Nonce
Type
string, required
Description
Single use per credential, kept until the timestamp plus 30 seconds. At least 16 characters. At most 128 characters.

Request

GET

/v1/campaigns/capabilities

curl "https://aggregator.asteriks.casino/v1/campaigns/capabilities" \
  -H "X-Api-Key: test-key-test-key" \
  -H "X-Timestamp: 1767225600" \
  -H "X-Nonce: docs-example-nonce-0001" \
  -H "X-Signature: Hv9c71iC5Y+P1fpURnU6tit6aNH6EGRCKo3NZOHhKx0="

200

Response

The answer is 200 with application/json.

Name
providers
Type
object[], required
Description
Name
providers[].provider
Type
string, required
Description
One of drakon, cocktail, games360, betting_software, electrobets.
Name
providers[].campaigns
Type
boolean, required
Description
Name
providers[].multiple_games
Type
boolean, required
Description
Name
providers[].deferred_start
Type
boolean, required
Description
Name
providers[].player_removal
Type
boolean, required
Description
Name
providers[].cancel
Type
boolean, required
Description
Name
providers[].rounds_min
Type
integer | null, required
Description
At least 1. At most 2147483647.
Name
providers[].rounds_max
Type
integer | null, required
Description
At least 1. At most 2147483647.

Errors

Each error carries one of these codes in the error object of Errors.

Name
MALFORMED_REQUEST
Type
400
Description
MALFORMED_REQUEST: a body, query or path value fails its schema.
Name
UNAUTHORIZED
Type
401
Description
UNAUTHORIZED: a missing or wrong key, signature, timestamp or nonce.

Response

{
  "providers": [
    {
      "provider": "drakon",
      "campaigns": true,
      "multiple_games": true,
      "deferred_start": true,
      "player_removal": true,
      "cancel": true,
      "rounds_min": 1,
      "rounds_max": 2147483647
    },
    {
      "provider": "cocktail",
      "campaigns": true,
      "multiple_games": false,
      "deferred_start": false,
      "player_removal": true,
      "cancel": true,
      "rounds_min": 1,
      "rounds_max": 1000
    },
    {
      "provider": "games360",
      "campaigns": false,
      "multiple_games": false,
      "deferred_start": false,
      "player_removal": false,
      "cancel": false,
      "rounds_min": null,
      "rounds_max": null
    },
    {
      "provider": "betting_software",
      "campaigns": false,
      "multiple_games": false,
      "deferred_start": false,
      "player_removal": false,
      "cancel": false,
      "rounds_min": null,
      "rounds_max": null
    },
    {
      "provider": "electrobets",
      "campaigns": false,
      "multiple_games": false,
      "deferred_start": false,
      "player_removal": false,
      "cancel": false,
      "rounds_min": null,
      "rounds_max": null
    }
  ]
}