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
Authentifizierung
Alle Endpoints erfordern einen API-Schlüssel über denX-API-Key-Header. Siehe Authentifizierung für Details.
Der veraltete
X-RxScale-Authorization-Header wird aus Gründen der Abwärtskompatibilität weiterhin unterstützt, jedoch wird X-API-Key für neue Integrationen empfohlen.Verfügbare Endpoints
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /products/{shop_identifier} | Produkte eines Shops auflisten |
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
| Endpoint | Erforderliche Berechtigung |
|---|---|
| Produkte auflisten | product:read |
| Bestellstatus abfragen | order:read |
| Rezept-Checkout erstellen | create_prescription_checkout |
| Behandlungs-Checkout erstellen | create_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.