Zum Hauptinhalt springen

​
Authentifizierung

Alle RxScale APIs verwenden API-Schlüssel-Authentifizierung. Fügen Sie Ihren API-Schlüssel bei jeder Anfrage im X-API-Key-Header hinzu.

​
API-Schlüssel-Header

curl -X GET "https://api.rxscale.com/v1/external-pharmacy-api-v1/health/" \
  -H "X-API-Key: your-api-key-here"

​
Legacy-Header (nur Public API)

Die Public API akzeptiert auch X-RxScale-Authorization als Alternative zu X-API-Key. Dies wird aus Gründen der Abwärtskompatibilität mit bestehenden Integrationen unterstützt. 
curl -X GET "https://api.rxscale.com/v2/public/health/" \
  -H "X-RxScale-Authorization: your-api-key-here"
Neue Integrationen sollten X-API-Key verwenden. Der X-RxScale-Authorization-Header wird nur auf Public API-Endpoints unterstützt.

​
API-Schlüssel-Typen

​
Pharmacy API-Schlüssel

Pharmacy API-Schlüssel können auf folgende Bereiche beschränkt werden:
  • Eine einzelne Apotheke — Der Schlüssel kann nur auf Daten dieser bestimmten Apotheke zugreifen.
  • Eine Apothekengruppe — Der Schlüssel kann auf Daten aller Apotheken in der Gruppe zugreifen. Bei Verwendung eines gruppenweiten Schlüssels müssen Sie den Query-Parameter pharmacy_uid angeben, um festzulegen, für welche Apotheke Sie handeln.

​
Management API-Schlüssel

Management API-Schlüssel sind auf eine Organisation beschränkt. Sie können auf Daten aller Entitäten innerhalb dieser Organisation zugreifen.

​
Berechtigungen

Jeder API-Schlüssel verfügt über eine Reihe von Berechtigungen, die steuern, auf welche Endpoints zugegriffen werden kann. Häufige Berechtigungen sind:
BerechtigungBeschreibung
orders_readBestellungen auflisten und anzeigen
orders_writeBestellstatus aktualisieren
stock_readSKUs und Lagerbestände auflisten
stock_writeLagerbestände aktualisieren
prescription:readRezeptdaten anzeigen
product:readProduktkatalog anzeigen
webhooks_readWebhook-Abonnements auflisten
webhooks_writeWebhooks registrieren und verwalten
Die Berechtigungen Ihres API-Schlüssels werden bei der Schlüsselerstellung festgelegt. Kontaktieren Sie Ihren RxScale-Kundenbetreuer, um Berechtigungen anzupassen.

​
Fehlerantworten

Wenn die Authentifizierung fehlschlägt, erhalten Sie eine der folgenden Antworten:
StatuscodeBeschreibung
401Fehlender oder ungültiger API-Schlüssel
403Gültiger API-Schlüssel, aber unzureichende Berechtigungen für diesen Endpoint
404Ressource nicht gefunden oder mit Ihrem Schlüssel nicht zugänglich
Aus Sicherheitsgründen gibt RxScale 404 Not Found anstelle von 403 Forbidden zurück, wenn Sie versuchen, auf eine Ressource außerhalb Ihres Bereichs zuzugreifen. Dies verhindert die Aufzählung von Ressourcen.