Skip to main content

​
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

​
Alternative Public API-Header

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.
Sie können denselben API-Schlüssel auch als Bearer-Token im Authorization-Header senden.
Neue Integrationen sollten X-API-Key verwenden, sofern Ihre Plattform keine Bearer-Token-Authentifizierung erfordert. Die Header X-RxScale-Authorization und Authorization: Bearer werden 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. Wird diese Apotheke entfernt, ist der Schlüssel nicht mehr gültig und jede Anfrage liefert 401.
  • 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:

​
API-Schlüssel erstellen

​
Als Admin (Management API & Public API)

  1. Melden Sie sich im Admin Tool an
  2. Navigieren Sie zu Einstellungen → API-Schlüssel
  3. Klicken Sie auf API-Schlüssel erstellen
  4. Geben Sie einen Anzeigenamen für den Schlüssel ein
  5. Wählen Sie die gewünschten Berechtigungen (z.B. order:read, product:read, prescription:read)
  6. Klicken Sie auf Erstellen — der Schlüssel wird einmalig angezeigt. Kopieren und sicher speichern.
Der API-Schlüssel wird nur einmal bei der Erstellung angezeigt. Wenn Sie ihn verlieren, müssen Sie einen neuen erstellen.

​
Als Apotheker (External Pharmacy API)

  1. Melden Sie sich im Apotheken-Tool an
  2. Navigieren Sie zu Einstellungen → API-Schlüssel
  3. Erstellen Sie einen neuen Schlüssel für Ihre Apotheke oder Apothekengruppe
  4. Wählen Sie die benötigten Berechtigungen (z.B. orders_read, orders_write, stock_read)
Apotheken-API-Schlüssel können auf eine einzelne Apotheke beschränkt oder für eine gesamte Apothekengruppe gültig sein. Gruppenweite Schlüssel erfordern den Parameter pharmacy_uid bei jeder Anfrage.

​
Fehlerantworten

Wenn die Authentifizierung fehlschlägt, erhalten Sie eine der folgenden Antworten:
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.
Anfragen, die wegen eines falschen Geheimnisses zu einem Ihrer API-Schlüssel (401) oder einer fehlenden Berechtigung (403) abgelehnt werden, werden im Audit-Log Ihrer Organisation festgehalten.