Skip to main content

​
Public API

The Public API provides access to product catalogs, prescription and treatment checkout creation, and order status queries. It is designed for customer-facing integrations such as storefronts and telemedicine platforms.

​
Base Path

​
Interactive API Documentation (Swagger)

A live Swagger UI is available for exploring and testing Public API endpoints directly in your browser:
The Swagger UI lets you try out API calls interactively. Authenticate with your API key to test against real data.

​
Authentication

All endpoints require an API key via the X-API-Key header. See Authentication for details.
The legacy X-RxScale-Authorization header and Authorization: Bearer <api-key> are also supported. X-API-Key is recommended unless your platform requires bearer-token authentication.
Every Public API request that can be tied to your organisation, including failed attempts, is recorded in your audit log.

​
Available Endpoints

​
Required Permissions

All Public API endpoints are scoped by shop_identifier in the URL path. The shop must belong to the organisation associated with your API key.