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.

​
External Pharmacy API

Die External Pharmacy API ermöglicht es Apotheken, ihre Bestellungen zu verwalten, Lagerbestände zu aktualisieren und Echtzeitbenachrichtigungen über Bestellungsänderungen zu erhalten.

​
Basispfad

/v1/external-pharmacy-api-v1

​
Interaktive API-Dokumentation (Swagger)

Eine Live-Swagger-Oberfläche steht zur Verfügung, um Endpoints direkt im Browser zu erkunden und zu testen: 
https://api.rxscale.com/v1/external_pharmacy_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. Weitere Informationen finden Sie unter Authentifizierung.

​
API-Schlüssel-Geltungsbereich

API-Schlüssel können entweder auf eine einzelne Apotheke oder auf eine gesamte Apothekengruppe beschränkt sein:
  • Einzelapotheken-Schlüssel sind an eine bestimmte Apotheke gebunden. Alle Anfragen werden automatisch auf diese Apotheke beschränkt, und es sind keine zusätzlichen Parameter erforderlich.
  • Gruppenweite Schlüssel decken alle Apotheken innerhalb einer Apothekengruppe ab. Bei Verwendung eines gruppenweiten API-Schlüssels ist der Query-Parameter pharmacy_uid bei den meisten Endpoints erforderlich, um anzugeben, für welche Apotheke Sie handeln.
# Gruppenweiter API-Schlüssel: pharmacy_uid ist erforderlich
GET /v1/external-pharmacy-api-v1/pharmacy_orders/?pharmacy_uid=your-pharmacy-uid

# Einzelapotheken-API-Schlüssel: keine pharmacy_uid nötig
GET /v1/external-pharmacy-api-v1/pharmacy_orders/
Wenn Sie einen gruppenweiten API-Schlüssel verwenden und den Parameter pharmacy_uid bei einem Endpoint weglassen, der ihn erfordert, gibt die Anfrage einen Fehler zurück.

​
Verfügbare Endpoints

MethodeEndpointBeschreibung
GET/pharmacy_orders/Apothekenbestellungen auflisten
GET/pharmacy_orders/{uid}Bestelldetails abrufen
PATCH/pharmacy_orders/{uid}/statusBestellstatus aktualisieren
PATCH/pharmacy_orders/{uid}/complete_orderBestellung abschließen
GET/pharmacy_skus/Apotheken-SKUs auflisten
PATCH/pharmacy_skus/{uid}SKU aktualisieren (Preis, Bestand, external_id)
PATCH/pharmacy_skus/{uid}/stockLagerbestand aktualisieren
PATCH/pharmacy_skus/{uid}/external_idExterne ID aktualisieren
GET/webhooks/Webhook-Abonnements auflisten
POST/webhooks/Webhook registrieren
DELETE/webhooks/{uid}Webhook entfernen

​
Erforderliche Berechtigungen

EndpointErforderliche Berechtigung
Bestellungen auflisten/anzeigenorders_read
Bestellungen aktualisieren oder abschließenorders_write
SKUs auflistenstock_read
SKU-Daten aktualisierenstock_write oder pharmacy_sku_write
Webhooks verwaltenwebhooks_read / webhooks_write