Key design concepts

API Endpoints versioning

The Bestmile Platform API versioning scheme adheres to the following rules:

  • Individual API endpoints are versioned independently.
  • Endpoints are continuously updated with new features or bug fixes. Backwards incompatible changes will always result in a new version number.

Available environments

An Environment is a distinct set of platform settings and data for different purposes.

Bestmile maintains two separate environments for end-user purposes: - Production - Sandbox


This is the live environment for real world usage with a guarantied availability following the service level agreement.

The base URL for REST API calls is:


This is the development and testing environment.

The base URL for sandbox API calls is: