# Operator API

> The server-to-server integration for casino operators and aggregators putting hizi.io games into their platform. It covers game launch, player management, balances and transactions, in real-money or demo mode. Every monetary value is an integer in 1/100 of the base currency.

Part of the hizi documentation at https://docs.hizi.io. The index of every section is https://docs.hizi.io/llms.txt.

## Operator API

- [Operator API](https://docs.hizi.io/operator-api/): Server-to-server integration for casino operators - game launch, player management, balances and transactions, in real-money or demo mode. Every monetary value is an integer in 1/100 of the base currency.
- [Operator → hizi.io](https://docs.hizi.io/operator-api/operator-to-hizi.html): The calls an operator makes to hizi.io to launch games and read game, round and transaction status. Only `getGameURL` is mandatory.
- [hizi.io -> Operator](https://docs.hizi.io/operator-api/hizi-to-operator.html): The calls the hizi.io backend makes to the operator backend, and the IP whitelisting that may apply to them.
- [Common definitions](https://docs.hizi.io/operator-api/common-definitions.html): The HTTP request header fields every call sends, and the conventions shared across the API.
- [Data types and definitions](https://docs.hizi.io/operator-api/data-types.html): Scalar types and the objects built from them, including the `amount` integer convention.

## Appendices

- [Appendix A - Events](https://docs.hizi.io/operator-api/appendix-a-events.html): Driving a running game from the host page with `postMessage` - the events the game accepts.
- [Appendix B - Backoffice Calls](https://docs.hizi.io/operator-api/appendix-b-backoffice.html): The backoffice call that queries every available game.
- [Appendix C - game settings parameters](https://docs.hizi.io/operator-api/appendix-c-game-settings.html): Every game setting you can pass at launch, as a named profile or as individual values.
- [Appendix D - Freeplays](https://docs.hizi.io/operator-api/appendix-d-free-plays.html): Granting freeplays to a player - the calls, and the account feature that must be enabled first.
- [Appendix E - Discounts](https://docs.hizi.io/operator-api/appendix-e-discounts.html): Live discounts - sending discount information with every balance reply, and how `doTransactions` applies it.
- [Appendix F - Health and Certified Hash endpoints](https://docs.hizi.io/operator-api/appendix-f-health.html): Checking game-engine health, and reading certified hashes and game versions.

## OpenAPI Reference

- [Operator API Reference](https://docs.hizi.io/operator-api/reference/): Generated reference for every Operator API call, callback and schema, rendered from the OpenAPI 3.0 specification.

## API reference: Operator → hizi.io

- [getGameURL](https://docs.hizi.io/operator-api/reference/getGameURL.html): `POST /getGameURL` - Get a game launch URL for a player and game
- [registerPlayer](https://docs.hizi.io/operator-api/reference/registerPlayer.html): `POST /registerPlayer` - Register (or update) a player in the hizi.io database
- [getPlayerDetails](https://docs.hizi.io/operator-api/reference/getPlayerDetails.html): `GET /getPlayerDetails` - Query the information stored for a player
- [setPlayerBlock](https://docs.hizi.io/operator-api/reference/setPlayerBlock.html): `POST /setPlayerBlock` - Block or unblock a player for all hizi.io games
- [getOpenGameRounds](https://docs.hizi.io/operator-api/reference/getOpenGameRounds.html): `GET /getOpenGameRounds` - List open real-money gamerounds for a player
- [getOpenGameRoundsByGame](https://docs.hizi.io/operator-api/reference/getOpenGameRoundsByGame.html): `GET /getOpenGameRoundsByGame` - List open real-money gamerounds for a game
- [getGameRoundDetails](https://docs.hizi.io/operator-api/reference/getGameRoundDetails.html): `GET /getGameRoundDetails` - Get the details of a single gameround
- [getGameRoundReport](https://docs.hizi.io/operator-api/reference/getGameRoundReport.html): `GET /getGameRoundReport` - List real-money gamerounds for a player and game
- [getGameRoundResult](https://docs.hizi.io/operator-api/reference/getGameRoundResult.html): `GET /getGameRoundResult` - Get an HTML representation of a gameround result
- [reconcileTransactions](https://docs.hizi.io/operator-api/reference/reconcileTransactions.html): `POST /reconcileTransactions` - Replay all transactions of a closed gameround to the operator
- [voidGameRound](https://docs.hizi.io/operator-api/reference/voidGameRound.html): `POST /voidGameRound` - Void the initial debit of an open gameround

## API reference: hizi.io → Operator

- [getBalance](https://docs.hizi.io/operator-api/reference/getBalance.html): `GET /getBalance` - (Operator implements) Get a player's balance
- [doTransactions](https://docs.hizi.io/operator-api/reference/doTransactions.html): `POST /doTransactions` - (Operator implements) Process one or more gameround transactions
- [logEvent](https://docs.hizi.io/operator-api/reference/logEvent.html): `POST /logEvent` - (Operator implements, optional) Receive a game event
- [doGameRoundReport](https://docs.hizi.io/operator-api/reference/doGameRoundReport.html): `POST /doGameRoundReport` - (Operator implements, optional) Receive the details of a closed round
- [doGameRoundResult](https://docs.hizi.io/operator-api/reference/doGameRoundResult.html): `POST /doGameRoundResult` - (Operator implements, optional) Receive the HTML result of a closed round
- [reportAnimationEnd](https://docs.hizi.io/operator-api/reference/reportAnimationEnd.html): `POST /reportAnimationEnd` - (Operator implements, optional) Receive the end-of-animation signal
- [ping](https://docs.hizi.io/operator-api/reference/ping.html): `GET /ping` - (Operator implements) Availability check of the operator service

## API reference: Discounts

- [getBalance](https://docs.hizi.io/operator-api/reference/getBalance.html): `GET /getBalance` - (Operator implements) Get a player's balance
- [doTransactions](https://docs.hizi.io/operator-api/reference/doTransactions.html): `POST /doTransactions` - (Operator implements) Process one or more gameround transactions

## API reference: Free Plays

- [assignPlayerFreerounds](https://docs.hizi.io/operator-api/reference/assignPlayerFreerounds.html): `POST /assignPlayerFreerounds` - Assign a package of free plays for a game and stake to a player
- [revokePlayerFreerounds](https://docs.hizi.io/operator-api/reference/revokePlayerFreerounds.html): `POST /revokePlayerFreerounds` - Revoke a previously granted free-play package
- [getPlayerFreerounds](https://docs.hizi.io/operator-api/reference/getPlayerFreerounds.html): `GET /getPlayerFreerounds` - Query the free-play packages available to a player

## API reference: Backoffice

- [getGameList](https://docs.hizi.io/operator-api/reference/getGameList.html): `GET /backoffice/getGameList` - Get the list of games available to the operator
- [getGameConfiguration](https://docs.hizi.io/operator-api/reference/getGameConfiguration.html): `GET /backoffice/getGameConfiguration` - Get the configuration of a game for a currency
- [getCurrencyList](https://docs.hizi.io/operator-api/reference/getCurrencyList.html): `GET /backoffice/getCurrencyList` - Get the list of known currencies and their multipliers
- [getStats](https://docs.hizi.io/operator-api/reference/getStats.html): `POST /backoffice/getStats` - Query statistical data on a daily basis
- [getTicketStats](https://docs.hizi.io/operator-api/reference/getTicketStats.html): `POST /backoffice/getTicketStats` - Query statistical data about tickets / free plays

## API reference: Health & Certified Hash

- [getGameEngineHealth](https://docs.hizi.io/operator-api/reference/getGameEngineHealth.html): `GET /gameapi/{gameCode}/health` - Health of a game engine
- [getGameEngineCertifiedFiles](https://docs.hizi.io/operator-api/reference/getGameEngineCertifiedFiles.html): `GET /gameapi/{gameCode}/certifiedfiles` - Certified file hashes / version of a game engine
- [getRngHealth](https://docs.hizi.io/operator-api/reference/getRngHealth.html): `GET /rngFortuna/health` - Health of the Fortuna RNG service
- [getRngCertifiedFiles](https://docs.hizi.io/operator-api/reference/getRngCertifiedFiles.html): `GET /rngFortuna/certifiedfiles` - Certified file hashes of the Fortuna RNG service
- [getSwissGameInfo](https://docs.hizi.io/operator-api/reference/getSwissGameInfo.html): `GET /game-swiss-info.json` - Game information document for Swiss regulation