Skip to main content

API Reference

Introduction

Welcome to the ZaveIT API documentation. This guide will help you integrate with the ZaveIT platform, access core services, and build custom solutions. The API is designed for simplicity, flexibility, and security, enabling you to manage accounts, subscriptions, orders, products, and more.

Overview​

The ZaveIT API is REST-based and uses JSON for requests and responses. It follows a clear and predictable structure, making it straightforward to connect your applications and services.

Example use cases​

  • Automating subscription management
  • Synchronizing product and price data
  • Integrating customer and order workflows
  • Fetching reporting and analytics data

Versioning​

The API uses versioning to manage changes. When breaking changes are required, a new version is introduced while older versions remain unchanged. This ensures existing integrations continue to work without disruption.

Only the latest version of each endpoint is displayed in this documentation. Older versions are not shown but remain available in the API until they are deprecated. Always use the latest version shown when building or updating integrations.

note

We recommend always using the latest available version when building or updating a solution, as older versions may eventually be deprecated.

Getting Started​

Generate an Access Token​

  1. Log in to the ZaveIT Platform.
  2. Navigate to Settings → Access Tokens.
  3. Click Generate token, add an optional description and expiration date, then click Generate.
  4. Store the generated token securely (it is only shown once).

Use this token in your application by adding it to the request header as session.