Übersicht

Public API für Produktkataloge und Checkout-Erstellung

​

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-api

​

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-api/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-api/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

Methode	Endpoint	Beschreibung
GET	/products/{shop_identifier}	Produkte eines Shops auflisten
POST	/products/{shop_identifier}/live-stock	Produktverfügbarkeit vor dem Checkout prüfen
POST	/products/{shop_identifier}/reservation	Produkte 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

Endpoint	Erforderliche Berechtigung
Produkte auflisten	product:read
Live Stock prüfen	product:read
Produkte reservieren	create_prescription_checkout
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.