OpenAPI

To support your development workflow, we provide the full definition of the Distribusion API in the OpenAPI Specification (OAS) 3.1.0 format. These files allow you to explore our endpoints, validate data structures, and automatically generate client SDKs.

Our OpenAPI files include:

• Comprehensive Resource Coverage: Detailed definitions for the entire booking lifecycle, including Connections, Reservations, Bookings, and Cancellations.
• JSON:API Standard Compliance: Full schemas for responses following the application/vnd.api+json format.
• Data Validation Rules: Clear constraints on data types, formats, and required fields to help you build robust integrations.
• Security Configuration: Pre-defined security schemes for ApiKeyAuth, requiring the Api-Key header for authenticated requests.
• Specialized Static Data Endpoints: Definitions for high-performance bulk retrieval of areas, cities, stations, and connected station mappings to power your search UI.

Files

You can download the specification for the Distribusion API in your preferred format below:

• Click to download our OpenAPI spec (JSON)
• Click to download our OpenAPI spec (YAML)

After downloading, you can import these files into local environments like Swagger UI or Postman to begin testing against our demo server: https://api.demo.distribusion.com/retailers/v4/.