Introduction

Server-to-server API for casino operators integrating with hizi.io — game launch, player management and transactions. (v1.8.8)

Source of truth: migrated from the original Google Doc. Please make edits here, not in the doc.

Scope

The Operator API provides a standardised, TypeScript-based interface for seamlessly integrating game clients with casino operators and aggregators. Designed for reliability and ease of use, it enables efficient management of game states, player interactions, and backend communications in real-money or demo modes.

Key functionalities include server-to-server calls for launching games, querying balances, processing transactions (e.g., debits, credits, voids), and handling events like spins, errors, and reality checks. It supports an event-based protocol for bidirectional communication via post messages between game iframes and operator lobbies, ensuring secure, idempotent operations with robust error handling and authentication.

Built-in compatibility with major aggregators facilitates multi-operator deployments. The API also offers methods for game control and optional backoffice calls for configurations and statistics.

Overview

The API consists of several parts.

Server to server calls

Calls from operator server to hizi.io server

Calls from hizi.io Server to operator server

All calls are done via HTTPS (note that HTTP is NOT supported). Calls have to be authenticated via one of the supported methods. GET calls should always use URL encoded parameters. POST calls have to be used with Content-Type header field set to application/json. As a character set, UTF8 should always be used. Please keep in mind that CORS policies may be in place. Response content type is application/json.

Basic flow is outlined here (note that additional calls may be possible, see detailed documentation in this document)

Post Messages to be used between game iFrame and operator lobby (embedding site)

Post Messages sent from game client to operator lobby

Post Messages sent from operator lobby to game client

Game client implementation

Calls from gameclient to hizi.io gameserver (only needed for game developers)

Backoffice calls

Calls that can be used to configure settings and game parameters. The functionality of these calls can also be accessed via the hizi.io Operator back office. The usage of these calls is optional as all settings can be made in the back office.