Перейти к содержимому

IZI API: обзор для разработчиков

Опубликовано: · IZI Team

IZI API — GraphQL-интерфейс для интеграции внешних систем с платформой управления компьютерным клубом. Через него партнёры подключают кассовые системы, платёжные шлюзы, мобильные приложения и кастомные дашборды.

Один endpoint, один протокол — никаких множественных REST-ресурсов.

Клиент (партнёр)
│ POST https://api.izi.is/graphql
│ Authorization: Bearer <jwt_token>
GraphQL Gateway
├── Clubs & Zones
├── Sessions & Devices
├── Clients & Balances
├── Tariffs & Payments
├── Analytics
└── Webhooks

Все операции — через единый endpoint. Запросы (query) читают данные, мутации (mutation) изменяют состояние, подписки (subscription) — потоковые события в реальном времени.

Окно терминала
curl -X POST https://api.izi.is/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{"query": "{ me { id email } }"}'

Ответ всегда в формате { "data": {...}, "errors": [...] }. Если errors присутствует — запрос выполнен частично или отклонён.

ДоменПримеры операций
АвторизацияloginWithEmailPassword, refreshToken
Клубыclubs, club, createClub, updateClub
Устройстваdevices, deviceStatus, updateDevice
СессииactiveSessions, startSession, endSession
Клиентыclients, clientByPhone, topUpBalance
Тарифыtariffs, purchaseTariff
АналитикаanalyticsRevenue, analyticsOccupancy
ВебхукиcreateWebhook, webhooks, deleteWebhook

IZI API не использует URL-версионирование (/v1/, /v2/). Изменения вносятся через deprecation: старые поля помечаются @deprecated с указанием замены, новые добавляются параллельно. Перед удалением поля команда IZI уведомляет партнёров за 30 дней.

Проверить статус поля:

{
__type(name: "Session") {
fields {
name
isDeprecated
deprecationReason
}
}
}
  • Ограничение частоты: 100 запросов / 10 секунд на токен (подробнее — Ограничения частоты запросов)
  • Доступность: 99,9% SLA для production-кластера
  • Регион: EU (Frankfurt) — основной, UAE — дополнительный

Частые вопросы

Какой протокол использует IZI API?

IZI API работает на GraphQL. Все запросы — POST на один endpoint: https://api.izi.is/graphql

Нужен ли OAuth для работы с API?

Нет. IZI использует JWT-токены. Получите токен через мутацию loginWithEmailPassword, передавайте в заголовке Authorization: Bearer <token>.

Есть ли REST API у IZI?

Публичного REST API нет. Всё взаимодействие — через GraphQL endpoint.

Как получить доступ к sandbox-окружению?

Sandbox-окружение доступно по запросу через команду IZI. Обратитесь к вашему менеджеру интеграции.