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
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
| Methode | Endpoint | Beschreibung |
|---|
GET | /orders/{order_uid} | Bestelldetails anzeigen |
GET | /prescriptions/{prescription_uid} | Rezeptdetails anzeigen |
GET | /products | Produkte mit SKUs auflisten |
GET | /doctors | Ärzte auflisten |
GET | /doctors/{doctor_uid}/statistics | Rezeptstatistiken 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/register | Patient für das Wartezimmer registrieren |
GET | /waiting-room/{queue_uid}/status | Warteschlangenstatus prüfen |
DELETE | /waiting-room/{queue_uid} | Warteschlangenregistrierung stornieren |
GET | /wallet-passes/templates | Wallet-Pass-Vorlagen auflisten |
GET | /wallet-passes | Wallet Passes auflisten |
POST | /wallet-passes/push-notifications | Push-Benachrichtigungen senden |
GET | /notification-subscriptions | Webhook-Abonnements auflisten |
POST | /notification-subscriptions | Webhook-Abonnement registrieren |
DELETE | /notification-subscriptions | Webhook-Abonnement entfernen |
POST | /notification-subscriptions/test | Webhook-Zustellung testen |
Erforderliche Berechtigungen
| Endpoint | Erforderliche Berechtigung |
|---|
| Bestellungen anzeigen | order:read |
| Rezepte anzeigen | prescription:read |
| Produkte auflisten | product:read |
| Ärzte auflisten | doctor:read |
| Arztstatistiken | doctor_statistics:read |
| Patienten anzeigen | patient:read |
| Wartezimmer registrieren / stornieren | waiting_room:write |
| Wartezimmerstatus anzeigen | waiting_room:read |
| Wallet-Pass-Vorlagen auflisten | wallet_pass_template:read |
| Wallet Passes auflisten | wallet_pass:read |
| Push-Benachrichtigungen senden | wallet_pass_push_notification:write |
Webhook-Abonnement-Endpoints (notification-subscriptions) erfordern keine spezifische Berechtigung über einen gültigen Management-API-Schlüssel hinaus.