Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.rxscale.com/llms.txt

Use this file to discover all available pages before exploring further.

Public API

Die Public API bietet Zugriff auf Produktkataloge, die Erstellung von Rezept- und Behandlungs-Checkouts sowie Bestellstatusabfragen. Sie ist für kundenorientierte Integrationen wie Onlineshops und Telemedizin-Plattformen konzipiert.

Basispfad

/v2/public

Interaktive API-Dokumentation (Swagger)

Eine Live-Swagger-Oberfläche steht zur Verfügung, um Public-API-Endpoints direkt im Browser zu erkunden und zu testen:
https://api.rxscale.com/v2/public/apidocs
Die Swagger-Oberfläche ermöglicht es Ihnen, API-Aufrufe interaktiv auszuprobieren. Authentifizieren Sie sich mit Ihrem API-Schlüssel, um gegen echte Daten zu testen.

Authentifizierung

Alle Endpoints erfordern einen API-Schlüssel über den X-API-Key-Header. Siehe Authentifizierung für Details.
curl -X GET "https://api.rxscale.com/v2/public/health/" \
  -H "X-API-Key: your-api-key-here"
Der veraltete X-RxScale-Authorization-Header und Authorization: Bearer <api-key> werden ebenfalls unterstützt. X-API-Key wird empfohlen, sofern Ihre Plattform keine Bearer-Token-Authentifizierung erfordert.

Verfügbare Endpoints

MethodeEndpointBeschreibung
GET/products/{shop_identifier}Produkte eines Shops auflisten
POST/products/{shop_identifier}/reservationProdukte in einem Shopify-Bestellentwurf reservieren
GET/orders/{shop_identifier}Bestellstatus anhand von Rezept-UIDs abfragen
POST/prescriptions/{shop_identifier}Rezeptbasierten Checkout erstellen
POST/treatments/{shop_identifier}Behandlungsbasierten Checkout erstellen

Erforderliche Berechtigungen

EndpointErforderliche Berechtigung
Produkte auflistenproduct:read
Produkte reservierencreate_prescription_checkout
Bestellstatus abfragenorder:read
Rezept-Checkout erstellencreate_prescription_checkout
Behandlungs-Checkout erstellencreate_treatment_checkout
Alle Public API Endpoints sind über den shop_identifier im URL-Pfad zugeordnet. Der Shop muss zur Organisation gehören, die mit Ihrem API-Schlüssel verknüpft ist.