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.

Management API

Die Management API bietet organisationsweiten Zugriff auf Bestellungen, Rezepte, Produkte, Ärzte, Patienten, Wartezimmer, Wallet Passes und Webhook-Abonnements. Sie ist für Back-Office-Integrationen und interne Tools konzipiert.

Basispfad

/v1/management

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/management/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. Management-API-Schlüssel sind auf eine Organisation beschränkt und können auf Daten aller Entitäten innerhalb dieser Organisation zugreifen. Siehe Authentifizierung für Details.
curl -X GET "https://api.rxscale.com/v1/management/health/" \
  -H "X-API-Key: your-api-key-here"

Verfügbare Endpoints

MethodeEndpointBeschreibung
GET/ordersBestellungen auflisten (paginiert)
GET/orders/{order_uid}Bestelldetails anzeigen
GET/prescriptions/{prescription_uid}Rezeptdetails anzeigen
GET/productsProdukte mit SKUs auflisten
GET/products/{product_uid}Produktdetails anzeigen
GET/doctorsÄrzte auflisten
GET/doctors/{doctor_uid}/statisticsRezeptstatistiken eines Arztes abrufen
GET/patients?email=...Patient per E-Mail suchen
GET/patients/{patient_uid}Patientenprofil anzeigen
GET/patients/{patient_uid}/intent/{intent}Patienten-Intent prüfen
POST/waiting-room/registerPatient für das Wartezimmer registrieren
GET/waiting-room/{queue_uid}/statusWarteschlangenstatus prüfen
DELETE/waiting-room/{queue_uid}Warteschlangenregistrierung stornieren
GET/wallet-passes/templatesWallet-Pass-Vorlagen auflisten
GET/wallet-passesWallet Passes auflisten
POST/wallet-passes/push-notificationsPush-Benachrichtigungen senden
GET/notification-subscriptionsWebhook-Abonnements auflisten
POST/notification-subscriptionsWebhook-Abonnement registrieren
DELETE/notification-subscriptionsWebhook-Abonnement entfernen
POST/notification-subscriptions/testWebhook-Zustellung testen

Erforderliche Berechtigungen

EndpointErforderliche Berechtigung
Bestellungen anzeigenorder:read
Rezepte anzeigenprescription:read
Produkte auflistenproduct:read
Ärzte auflistendoctor:read
Arztstatistikendoctor_statistics:read
Patienten anzeigenpatient:read
Wartezimmer registrieren / stornierenwaiting_room:write
Wartezimmerstatus anzeigenwaiting_room:read
Wallet-Pass-Vorlagen auflistenwallet_pass_template:read
Wallet Passes auflistenwallet_pass:read
Push-Benachrichtigungen sendenwallet_pass_push_notification:write
Webhook-Abonnement-Endpoints (notification-subscriptions) erfordern keine spezifische Berechtigung über einen gültigen Management-API-Schlüssel hinaus.