Versioning

3min

Understanding Our API Documentation Versions

Welcome to our API Documentation Versioning page! As our suite of APIs evolves, we maintain different versions of documentation to meet the diverse needs of our users. Below, you'll find a clear explanation of our "Main" and "v1" documentation versions, helping you navigate to the information most relevant to you.

Main Documentation

Overview: The Main documentation is your comprehensive guide to the latest features of our APIs. It is continuously updated to reflect the most current versions, ensuring you have access to the newest information and capabilities.

Contents:

  • All API Versions: Includes detailed information on all available and latest API versions, this could include both v1 and v2 but will always have the latest version of each API.
  • Latest Features: Stay up-to-date with the newest features, enhancements, and fixes.
  • Comprehensive Guides: Provides in-depth tutorials, use cases, and examples for all API versions.

Ideal For: Developers and users seeking the most current information, those utilizing multiple API versions, or anyone needing to stay abreast of the latest API developments.

Legacy Documentation

Overview: The legacy documentation is dedicated to older versions of our APIs, ensuring legacy support and ease of access to specific information for previous versions.

Contents:

  • v1 API Exclusive: Focused solely on the v1 API, offering detailed guides and reference material.
  • Legacy Support: Essential for maintaining and troubleshooting existing v1 API integrations.
  • Targeted Tutorials: Includes specific examples, use cases, and troubleshooting for v1 API.
  • Ideal For: Users who are currently implementing, maintaining, or operating systems based on the previous versions of the API.

We are committed to providing clear and accessible documentation for all our users. Whether you're working with the main/latest version of our API or maintaining legacy/older versions, our documentation is designed to support your needs. If you have any questions or need further assistance, please don't hesitate to contact our support team.