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

/v2/public

​
Authentication

All endpoints require an API key via the X-API-Key header. See Authentication for details. 
curl -X GET "https://api.rxscale.com/v2/public/health/" \
  -H "X-API-Key: your-api-key-here"
The legacy X-RxScale-Authorization header is also supported for backward compatibility but X-API-Key is recommended for new integrations.

​
Available Endpoints

MethodEndpointDescription
GET/products/{shop_identifier}List products for a shop
GET/orders/{shop_identifier}Get order status by prescription UIDs
POST/prescriptions/{shop_identifier}Create a prescription-based checkout
POST/treatments/{shop_identifier}Create a treatment-based checkout

​
Required Permissions

EndpointRequired Permission
List productsproduct:read
Get order statusorder:read
Create prescription checkoutcreate_prescription_checkout
Create treatment checkoutcreate_treatment_checkout
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.