Skip to content

Basics ​

Third-party game engines use API V2 to interface directly with the hizi.io RGS. You can also use API V2 for a RGS-to-RGS integration. API V2 also provides a call for the hizi.io certified RNG.

API V2 uses HTTP. Expose an HTTP endpoint to receive incoming calls. Send HTTP POST requests to the hizi.io RGS.

Integration models and what each needs ​

There are two integration models. They have very different setup requirements:

Classic RGS-to-RGS (the typical case)hizi.io-hosted engine (direct engine integration / "RGS inception")
Where your game logic runsOn your own infrastructureInside the hizi.io RGS
TransportHTTP/2HTTP/2
RNGYour own certified RNG (pass results in rngResult)hizi.io certified RNG via /getRandomResult
CertificationYou run your own certification on your own infrastructure. hizi.io is not involved. You expose your certified file hashes via /certifiedfilesBuilt and certified within the hizi.io stack

If you do a classic RGS-to-RGS integration, you only implement this HTTP/2 API on your own infrastructure. This API alone connects your RGS to hizi.io. Your certification is entirely your own responsibility. You run it yourself. hizi.io has no role in it (there is no hizi.io certification suite for you to obtain).

RNG: which integrations need the hizi.io certified RNG? ​

The /getRandomResult call to the hizi.io certified RNG is relevant only when the game logic runs inside the hizi.io RGS. In this case, the game logic must obtain its randomness from hizi.io for compliance:

  • Direct game engine integration hosted by hizi.io, or a partner RGS hosted within the hizi.io RGS ("RGS inception"), uses /getRandomResult.
  • Classic RGS-to-RGS integration (your RGS runs on your own infrastructure, the typical case) does not use /getRandomResult. Keep using your own certified RNG (for example, a provably-fair one). Pass its results in the rngResult fields of the gameround calls. You run your certification on your own infrastructure. hizi.io is not involved. hizi.io provides no certification suite for it. No part of hizi.io expects /getRandomResult calls from such integrations.

See /getRandomResult for details.

Important notes ​

    All amounts in calls, payloads, and responses are in minor units (1/100 of the currency)
    Make all calls idempotent on the hashes passed

Information flow for game engines ​

game-studio-api figure 3

Information flow for RGS-to-RGS communication ​

game-studio-api figure 4