इसे छोड़कर कंटेंट पर जाएं

IZI API: Developer Overview

Опубликовано: · Обновлено: (1 месяц назад)· IZI Team

यह कंटेंट अभी तक आपकी भाषा में उपलब्ध नहीं है।

IZI API is the platform’s GraphQL interface. IZI CRM, the player mobile app and the client on gaming PCs all work through this same API.

One protocol and one /graphql path per contour — no separate REST resources.

IZI runs several independent contours. Each has its own database: a club and its data are available only through the API of the contour where the club is registered.

ContourGraphQL over HTTPSSubscriptions (WebSocket)
Mainhttps://api.x.izi.is/graphqlwss://api.x.izi.is/graphql
Russiahttps://api.izi-is.ru/graphqlwss://api.izi-is.ru/graphql
Saudi Arabiahttps://api.sa.izi.is/graphqlwss://api.sa.izi.is/graphql
IZI developmenthttps://api.dev.x.izi.is/graphqlwss://api.dev.x.izi.is/graphql

Clubs in Russia and Belarus run on the Russian contour, clubs in Saudi Arabia on the sa contour, and clubs in all other countries on the main one. This is a hard rule, not a tendency: a club can only be created on the contour that bills its country, otherwise the API answers with InvalidInput. The development contour is IZI’s internal stand with test data.

The main, Russian and development contours also have a fallback entry point through a proxy abroad, for networks where the direct path is blocked: https://api-x.izi-is.ru/graphql for the main contour, https://api-ru.x.izi.is/graphql for the Russian one, and https://api-dev-x.izi-is.ru/graphql for development. The sa contour has no fallback. Do not hard-code these addresses: the public clusterConfig(country:) query returns a contour’s current addresses in baseUrls, including fallback, and IZI’s own clients use whichever entry point answered first.

Terminal window
curl -X POST https://api.x.izi.is/graphql \
-H "Content-Type: application/json" \
-d '{"query": "query ClubList { clubs(limit: 5) { items { id name city } totalCount } }"}'

Every operation must have a name (query ClubList { ... }). The server rejects an unnamed operation with the code InvalidInput.

The response is always { "data": {...}, "errors": [...] }. If errors is present, the request was partially executed or rejected.

Access to every field of the schema is declared explicitly:

  • No token — only fields open to anonymous access. There are 45 of them out of roughly 760 root fields, among them the catalog of clubs, zones, devices, tariffs, products and promotions, plus the login and sign-up mutations.
  • CRM token — issued to a club employee who signs in by email (Authentication & Tokens). What the employee can do is defined by the permissions of their role — except for a few organization-level operations that require ownership or full access and are granted by no role.
  • PLAYER token — issued to a player who signs in to the mobile app by phone, and bound to that player.

There is no separate API key or service account for integrations: every token belongs to a specific employee or player.

The table lists only operations that exist in the schema, with the role that can call them.

DomainOperationTypeAccess
AuthenticationloginWithEmailPasswordmutationno token
Clubsclubs, club(id:)queryno token
ClubscreateClubmutationCRM — organization owner or full access
ClubsupdateClubmutationCRM — CLUB_EDIT permission
Devicesdevices(filters: { clubId })queryno token
DevicesupdateDevicemutationCRM — DEVICE_EDIT permission
SessionsstartSession, endSessionmutationCRM, PLAYER
Tariffstariffs(filters: { clubId })queryno token

Mind the required arguments: on devices and tariffs the filters argument is required, and clubId inside it is required too — a call without them is rejected with HTTP 400 and the code GRAPHQL_VALIDATION_FAILED. clubs has no required argument at all. Introspection is disabled, so ask IZI for the signatures of the other operations together with the schema.

createClub access is not a role permission: the operation is performed by the organization owner, a member with full access (fullAccess), or IZI staff. A role holding every club permission still cannot call it.

Introspection (__schema, __type) is disabled on every contour: such a query returns an error. To get the current schema (SDL), contact IZI.

IZI API does not use URL versioning (/v1/, /v2/). Changes are made with the @deprecated marker: the old field is marked with its replacement, and the new field is added alongside it.

अक्सर पूछे जाने वाले सवाल

What protocol does IZI API use?

GraphQL. All requests are POST to /graphql on the API host of your contour, for example https://api.x.izi.is/graphql. The Russian contour has its own address: https://api.izi-is.ru/graphql.

Does IZI API use OAuth?

No. IZI uses JWT tokens. A club employee gets a token via the loginWithEmailPassword mutation and passes it in the Authorization: Bearer <token> header.

Is there a REST API?

No. Data is read and changed only through GraphQL. The API has separate HTTP addresses only for service needs, such as notifications from payment providers.

What is available without a token?

Only fields open to anonymous access: among them the catalog of clubs, zones, tariffs, products and promotions, plus the login and sign-up mutations. Everything else requires a club employee token (CRM) or a player token (PLAYER).

About IZI