hizi docs

Appearance

Query the free-play packages available to a player​

GET
/getPlayerFreerounds

Returns the packages still available for a player, game and currency. Packages that are fully used or expired are not reported.

Fields to sign (in order): secret, X-H-AUTH-ID, X-H-TIMESTAMP, playerId, gameCode, currency.

Authorizations​

hiziAuthId

Operator ID. Sent on every request in both directions, and part of every signature.

Type
API Key (header: X-H-AUTH-ID)
+
hiziAuthSignature

Signature of the request, sent on every request in both directions.

OpenAPI cannot express an HMAC-over-computed-string scheme natively, so this is modelled as an apiKey header. The value is not a static key: it is the base64-encoded SHA-256 HMAC digest of a defined, ordered set of request fields joined with a hash character (#).

The first three fields are always the shared secret, the X-H-AUTH-ID header and the X-H-TIMESTAMP header; the remaining fields differ per operation and are listed in each operation's description under "Fields to sign". For doTransactions the per- transaction hashes (and non-zero amounts) are appended in exactly the order the transactions appear in the payload.

The secret is retrieved by logging in to the hizi.io backoffice, which also provides sample implementations. Including the timestamp in the signature is what makes it safe to share the secret without ever sending it.

Type
API Key (header: X-H-AUTH-SIG)
+
hiziTimestamp

ISO 8601 timestamp of the request (UTC recommended, e.g. 2020-01-21T14:48:04Z). Sent on every request in both directions and always included in the signature.

Type
API Key (header: X-H-TIMESTAMP)

Parameters​

Query Parameters

playerId*

ID that identifies the player at the operator site.

Type
string
Required
gameCode*

Code that identifies the game, as returned by getGameList or passed to getGameURL.

Type
string
Required
currency*

ISO 4217 currency code the call applies to.

Type
string
Required
Example"EUR"
Pattern
"^[A-Z]{3}$"

Responses​

Available free-play packages.

application/json
JSON
{
  
"tickets": [
  
  
{
  
  
  
"serial": "string",
  
  
  
"stake": 1200,
  
  
  
"currency": "EUR",
  
  
  
"availableTickets": 0
  
  
}
  
],
  
"errorCode": {
  
  
"id": 1,
  
  
"msg": "player id unknown",
  
  
"clientmsg": "You reached your daily betting limit!"
  
}
}

Samples​

Powered by VitePress OpenAPI