API Versioning Documentation

Welcome to the API versioning guide. This document provides instructions on how to specify and manage API versions in your requests to ensure compatibility and access to the correct API features.

We strive for backwards compatibility and will always look to minimize the number of changes between versions.

Versioning Methods

Our API uses URL Path Versioning to manage different versions of the API. This means the version of the API you want to access is determined by the URL path.

URL Path Versioning

URL Path Versioning requires including the version number in the URL path of your API request. This ensures that you are interacting with the intended version of the API.

Format

To access a specific version of the API, include the version number in the URL as follows:

/api/your-endpoint/?version=0.1

Example for Version 1:

GET /api/your-endpoint/?version=0.1

Current Default Version

By default, the API will use the latest version if no version is specified. The current version can be found by calling the versions endpoint:

Versions Endpoint

Allowed Versions

The supported versions can be found by calling the versions endpoint:

Versions Endpoint

Best Practices

• Always specify the version in your URL to ensure compatibility.
• Refer to the documentation for each version to understand the available endpoints and changes.
• Monitor announcements for new versions and deprecation schedules to maintain compatibility.

For further assistance or details about specific versions, please refer to the official API version documentation or contact support. Happy coding!