Game Studio API

The Game Studio API V2 is the interface for game engines and third-party RGS to integrate with the hizi.io platform. It covers game launches, round management, and certified RNG.

Scope

This document contains specifications for the hizi.io API V2. This API has two purposes. First, it lets games connect to the hizi.io Remote Gaming Server (RGS). This is also known as the "powered by" programme. Second, it lets a third-party RGS communicate with the hizi.io RGS. This is RGS-to-RGS integration. The API supports communication between game clients, backends, and operators. It supports direct game engine integrations. It also supports RGS-to-RGS interactions.

The API has key purposes. It enables secure, scalable game launches in real-money mode or demo mode. It manages gamerounds. Gameround operations include starting, ending, wagering, and collecting wins. It gives access to certified Random Number Generator (RNG) services. The API supports two communication methods. The first method is RabbitMQ message queuing, for efficient, fault-tolerant exchanges. The second method is RESTful HTTP/2 endpoints, for broader compatibility.

This document also covers detailed specifications for endpoints, data structures, and flows. These include retrieval of game configuration, handling of freeplay, health checks, and management of errors, among others.

Further references

Error codes	Response Codes & Error Codes
HTTP return codes	Response Codes & Error Codes
Response headers	Response Codes & Error Codes

What's In This Section

• OpenAPI Reference: Every call and callback, with parameters, schemas, examples, and copy-paste code samples (Browse the API Reference).
• Transports: How to connect to the hizi.io RGS over RabbitMQ message queuing or over RESTful HTTP/2 endpoints (Basics).
• Game Launch & Configuration: How to retrieve the game configuration and launch a game in real-money mode or demo mode (Game Launch).
• Round Lifecycle: How to start a gameround, wager, end the round, and collect the wins across sequential calls (Calls Provided by API V2).
• Freeplays & Certified RNG: How to handle freeplay rounds and how to use the certified RNG services for regulated markets (Freeplays).
• Reliability: Request signing, health checks, and the defined handling for lost responses and retries (Lost Responses & Retries).

OpenAPI Specification

This site provides a machine-readable OpenAPI 3.0 specification. It covers every documented call, callback, and data structure on this page. Point your tooling (codegen, request collections, or LLM/agent integrations) at https://docs.hizi.io/game-studio-api/openapi.yaml. The site generates the spec from this prose documentation. The spec notes a few places where the source docs are ambiguous or contradictory. Where the spec and this documentation conflict, treat those notes as authoritative over the spec's own types.

The site also renders the same spec as a browsable OpenAPI Reference, with one page per operation.