Skip to main content

Versioning Principle

The API version number is included in the base URL:

Changes Without Version Update

The following modifications do not require a major version change:
  • URL modifications (other than the base URL)
  • Addition of new fields in a response
  • Addition of new request parameters
  • Addition/removal/modification of ENUM values
  • Modification of pagination page sizes
Your code should be designed to ignore unknown fields in responses to remain compatible with these evolutions.

Changes With Version Update

A major version change (e.g., v1 → v2) will only occur for:
  • Removal of existing fields
  • Change in data type of a field
  • Incompatible behavior change
  • Modifications that may cause client malfunctions

Version Monitoring

Fields to Monitor

Regularly query the root resource to monitor changes:
Important fields:
  • _version: Current minor version (e.g., “1.10”)
  • _last_version_url: URL of the latest available version
  • _expiration: Expiration date of the current version
  • _changelog: Link to modification history

Example Response

Interpretation

Setting Up Alerts

Monitoring Script (Python)

Monitoring Script (Shell)

Migration Process

When a new major version is announced:
1

Transition period

Both versions (old and new) remain accessible simultaneously
2

Test the new version

Test your integration with the new URL provided by _last_version_url
3

Adapt your code

Make necessary modifications for compatibility
4

Deploy changes

Update your production code before the expiration date
5

Post-migration monitoring

Verify that everything works correctly with the new version

Changelog

The changelog is accessible via the URL provided in the root response:
It documents:
  • New features
  • Bug fixes
  • Behavior changes
  • Deprecations
  • Migration announcements
Regularly consult the changelog to discover new possibilities and optimize your integration.

Best Practices

Design for Compatibility

  1. Ignore unknown fields: Don’t fail on unrecognized fields
  2. Use provided URLs: Never manually construct URLs
  3. Version your code: Keep track of which API version is used
  4. Test regularly: Validate your integration with each minor evolution

Robust Code Example (Python)

Support

For any migration questions: