Appearance
Get an HTML representation of a gameround result
GET
/getGameRoundResult
Returns the rendered result of a gameround, either as HTML markup or as a short-lived URL that displays it.
The response is application/json in both cases (as for every other call): with getURL=true the JSON contains resultURL, a link that stays valid for 10 minutes; with getURL false or absent it contains the HTML markup in the msg string together with the gameCode of the round.
Fields to sign (in order): secret, X-H-AUTH-ID, X-H-TIMESTAMP, playerId, gameRound.
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
Requiredstring
gameRound*
Hash that identifies the gameround, as returned by e.g. getOpenGameRounds or getGameRoundReport.
Required
getURL
If true, return a resultURL valid for 10 minutes instead of the HTML markup. If false or omitted, the HTML markup is returned in msg.
Type
boolean
Responses
Gameround result, either as HTML markup in msg or as a link in resultURL.
application/json
JSON "resultURL": "string", "msg": "string", "gameCode": "string", "errorCode": { "id": 1, "msg": "player id unknown", "clientmsg": "You reached your daily betting limit!" }
{
}