IZI API for Developers — Overview
IZI API for Developers
Section titled “IZI API for Developers”IZI exposes a GraphQL API that lets you read and write data across your gaming club — sessions, tariffs, payments, shift reports, and more. Whether you are building a custom dashboard, syncing data with a third-party accounting tool, or automating recurring workflows, the sections below cover everything you need to get started and stay unblocked.
In this section
Section titled “In this section”- API Overview
- GraphQL Basics
- Authentication & Tokens
- Webhooks
- Rate Limits
- CloudPayments Integration
- Error Codes
- SDK Examples
Related topics
Section titled “Related topics”- Gaming Club Software Overview
- Shift Management in IZI
- IZI Tariff Configuration
Frequently asked questions
What protocol does the IZI API use?
IZI uses GraphQL over HTTPS. All queries and mutations go to a single endpoint, and you shape the response to include only the fields your integration needs.
How do I authenticate with the IZI API?
Obtain a session token via the loginWithEmailPassword mutation, then pass it in the Authorization header as a Bearer token on every subsequent request.
Does IZI support webhooks?
Yes. IZI can push real-time event notifications — session start/end, payment confirmed, shift closed, and more — to any HTTPS endpoint you register.
What data can I read through the IZI API?
You can query sessions, tariffs, payments, shift reports, client profiles, bonus balances, and computer/station status. The schema covers all core club operations.
Can I write data back through the API, or is it read-only?
The API supports both queries (read) and mutations (write). You can open sessions, apply tariff changes, process payments, and update client records via mutations.
Are there rate limits on the IZI API?
Yes. Default limits apply per token. See the Rate Limits page for exact thresholds and guidance on how to handle 429 responses with exponential backoff.
Does IZI provide an SDK or code examples?
SDK examples covering JavaScript, Python, and curl are available in the SDK Examples section. They cover authentication, common queries, and webhook handling.
How do I integrate IZI with CloudPayments?
IZI has a first-party CloudPayments integration. The CloudPayments Integration guide walks through credential setup, payment flow, and reconciliation.
What HTTP status codes does the IZI API return?
The API returns standard HTTP codes plus GraphQL-level errors in the response body. The Error Codes reference lists every code, its meaning, and the recommended fix.
Where do I start if I am new to the IZI API?
Start with the API Overview to understand the architecture, then follow the Authentication guide to get a working token. After that, explore the GraphQL Basics page to run your first query.