Introduction

RGS / Game Studio API V2 — the interface for game engines and third-party RGS to integrate with the hizi.io platform. (v1.18)

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

Scope

This document includes specifications for the hizi.io API V2. The purpose of this API is to enable games to connect to the hizi.io Remote gaming server (RGS ) (a.k.a powered by programme) on one hand and to enable a third party RGS to communicate with the hizi.io RGS (a.k.a RGS-to-RGS integration). It facilitates seamless communication between game clients, backends, and operators, supporting both direct game engine integrations and RGS-to-RGS interactions.

Key purposes include enabling secure, scalable game launches in real-money or demo modes; managing game rounds with operations like starting, ending, wagering, and collecting wins; and accessing certified Random Number Generator (RNG) services. The API supports two communication methods: RabbitMQ message queuing for efficient, fault-tolerant exchanges, or RESTful HTTP/2 endpoints for broader compatibility.

It encompasses detailed specifications for endpoints, data structures, and flows, including game configuration retrieval, freeplay handling, health checks, and error management, among others.

Further references

Definition of V2 interfaces	https://docs.google.com/document/d/e/2PACX-1vQgmKeZRiFqzleyFm5jbTIKGtDDbfEtM2WnxVMl0OEfuYoSx7xyORS9-7K97aDbCwXtoIDAsQVQf82n/pub?embedded=true
API return codes	Operator API
HTTP status codes	Operator API
custom HTTP headers	Operator API
Operator API reference	Operator API