Management API
Die Management API bietet organisationsweiten Zugriff auf Bestellungen, Rezepte, Produkte, Ärzte, Patienten, Wartezimmer, Listing-Anfragen, 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
Jeder Endpoint akzeptiert entweder einen API-Schlüssel über denX-API-Key-Header oder ein von Auth0 ausgestelltes OAuth-Bearer-Token über den Authorization-Header. Beide sind auf eine Organisation beschränkt und können auf Daten aller Entitäten innerhalb dieser Organisation zugreifen. Siehe Authentifizierung für Details, wie Sie eine der beiden Anmeldeinformationen erhalten und für welche Audience ein Bearer-Token ausgestellt sein muss.
curl -X GET "https://api.rxscale.com/v1/management/health/" \
-H "X-API-Key: your-api-key-here"
curl -X GET "https://api.rxscale.com/v1/management/health/" \
-H "Authorization: Bearer your-access-token-here"
Sie können auch einen KI-Client (Cursor, Claude Desktop, …) direkt über MCP mit dieser API verbinden — mit der von RxScale bereitgestellten Auth0-Anwendung, ohne dass ein API-Schlüssel in der Client-Konfiguration nötig ist. Siehe den Management-API-MCP-Leitfaden.
Verfügbare Endpoints
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /orders | Bestellungen auflisten (paginiert) |
GET | /orders/{order_uid} | Bestelldetails anzeigen |
POST | /orders | Bestellung aus Ihrem eigenen Vertriebskanal anlegen (Bestellerfassung) |
POST | /orders/{external_id}/fulfillments | Neuen Fulfillment-Auftrag zu einer bestehenden Bestellung hinzufügen |
PATCH | /orders/{external_id} | Positionsfreie Bestellfelder aktualisieren |
POST | /orders/{external_id}/fulfillments/{fulfillment_external_id}/cancel | Fulfillment-Auftrag stornieren |
GET | /prescriptions/{prescription_uid} | Rezeptdetails anzeigen |
GET | /prescriptions/statistics | Anzahl der Rezepte pro Status abrufen |
GET | /products | Produkte mit SKUs auflisten (paginiert) |
POST | /products | Produkt anlegen |
GET | /products/{product_uid} | Produktdetails anzeigen |
PATCH | /products/{product_uid} | Produkt aktualisieren |
DELETE | /products/{product_uid} | Produkt löschen |
GET | /skus | SKUs auflisten |
POST | /skus | SKU anlegen |
GET | /skus/{sku_uid} | SKU-Details anzeigen |
PATCH | /skus/{sku_uid} | SKU aktualisieren |
DELETE | /skus/{sku_uid} | SKU löschen |
GET | /shop-skus | Shop-SKUs auflisten |
POST | /shop-skus | Shop-SKU anlegen |
GET | /shop-skus/{shop_sku_uid} | Shop-SKU-Details anzeigen |
PATCH | /shop-skus/{shop_sku_uid} | Shop-SKU aktualisieren |
DELETE | /shop-skus/{shop_sku_uid} | Shop-SKU löschen |
GET | /shop-products | Shop-Produkte auflisten |
POST | /shop-products | Shop-Produkt anlegen |
GET | /shop-products/{shop_product_uid} | Shop-Produkt-Details anzeigen |
PATCH | /shop-products/{shop_product_uid} | Shop-Produkt aktualisieren |
DELETE | /shop-products/{shop_product_uid} | Shop-Produkt löschen |
GET | /questionnaires | Fragebögen auflisten (paginiert) (Fragebögen) |
POST | /questionnaires | Fragebogen anlegen |
GET | /questionnaires/{questionnaire_uid} | Fragebogen anzeigen |
PATCH | /questionnaires/{questionnaire_uid} | Fragebogen-Metadaten aktualisieren |
PATCH | /questionnaires/{questionnaire_uid}/model | SurveyJS-Modell eines Fragebogens veröffentlichen |
GET | /questionnaires/{questionnaire_uid}/statistics/submissions | Einreichungen pro Tag für einen Fragebogen |
GET | /doctors | Ärzte auflisten (paginiert) |
GET | /doctors/{doctor_uid}/statistics | Rezeptstatistiken eines Arztes abrufen |
GET | /doctors/{doctor_uid}/blacklisted-skus | Für einen Arzt gesperrte SKUs auflisten (paginiert) |
POST | /doctors/{doctor_uid}/blacklisted-skus | SKU für einen Arzt sperren |
DELETE | /doctors/{doctor_uid}/blacklisted-skus/{sku_uid} | SKU von der Sperrliste eines Arztes entfernen |
GET | /statistics/dashboard | Dashboard-Statistiken der Organisation (Statistiken) |
GET | /statistics/doctors | Rezeptstatistiken für alle Ärzte der Organisation |
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 |
POST | /review-links | Einmalig verwendbaren Prüf-Link für eine Apothekenbestellung erstellen |
GET | /review-links | Prüf-Links auflisten |
DELETE | /review-links/{uid} | Prüf-Link widerrufen |
GET | /listing-requests | Listing-Anfragen auflisten (paginiert) |
GET | /listing-requests/{uid} | Listing-Anfrage anzeigen |
POST | /listing-requests/{uid}/accept | Offene Listing-Anfrage annehmen |
POST | /listing-requests/{uid}/decline | Offene Listing-Anfrage ablehnen |
GET | /wallet-passes/templates | Wallet-Pass-Vorlagen auflisten |
GET | /wallet-passes | Wallet Passes auflisten |
POST | /wallet-passes | Wallet Pass für einen Patienten ausstellen |
GET | /wallet-passes/{wallet_pass_uid} | Einzelnen Wallet Pass abrufen |
DELETE | /wallet-passes/{wallet_pass_uid} | Wallet Pass widerrufen |
POST | /wallet-passes/verify | Gescannten Wallet Pass verifizieren |
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 |
GET | /scheduling/appointments | Geplante Termine auflisten (paginiert) |
POST | /scheduling/appointments/{meeting_uid}/cancel | Geplanten Termin absagen |
GET | /scheduling/appointment-types | Termintypen auflisten |
POST | /scheduling/appointment-types | Termintyp anlegen |
PATCH | /scheduling/appointment-types/{uid} | Termintyp aktualisieren |
DELETE | /scheduling/appointment-types/{uid} | Termintyp löschen |
GET | /scheduling/appointment-types/{uid}/reminders | Erinnerungen eines Termintyps auflisten |
POST | /scheduling/appointment-types/{uid}/reminders | Erinnerung für einen Termintyp anlegen |
PATCH | /scheduling/appointment-types/{uid}/reminders/{reminder_uid} | Erinnerung aktualisieren |
DELETE | /scheduling/appointment-types/{uid}/reminders/{reminder_uid} | Erinnerung löschen |
GET | /scheduling/doctors/{doctor_uid}/availability-rules | Verfügbarkeitsregeln eines Arztes auflisten |
POST | /scheduling/doctors/{doctor_uid}/availability-rules | Verfügbarkeitsregel anlegen |
PATCH | /scheduling/doctors/{doctor_uid}/availability-rules/{rule_uid} | Verfügbarkeitsregel aktualisieren |
DELETE | /scheduling/doctors/{doctor_uid}/availability-rules/{rule_uid} | Verfügbarkeitsregel löschen |
GET | /scheduling/doctors/{doctor_uid}/availability-date-overrides | Datums-Ausnahmen auflisten (paginiert) |
POST | /scheduling/doctors/{doctor_uid}/availability-date-overrides | Datums-Ausnahme anlegen |
PATCH | /scheduling/doctors/{doctor_uid}/availability-date-overrides/{override_uid} | Datums-Ausnahme aktualisieren |
DELETE | /scheduling/doctors/{doctor_uid}/availability-date-overrides/{override_uid} | Datums-Ausnahme löschen |
POST | /anamnesis/patient-connections | Anamnese-Einreichung mit einem Patienten verknüpfen |
POST | /review-requests | Einen Arzt bitten, einen Patienten zu prüfen (Review-Anfragen) |
GET | /review-requests/{review_request_uid} | Den aktuellen Stand einer Review-Anfrage abrufen |
POST | /review-requests/{review_request_uid}/cancel | Eine Review-Anfrage stornieren |
GET | /telemedicine-providers | Mit der Organisation verbundene Telemedizin-Anbieter auflisten (Telemedizin-Anbieter) |
GET | /telemedicine-providers/{uid}/settings | Einstellungen eines Telemedizin-Anbieters abrufen |
PATCH | /telemedicine-providers/{uid}/settings | Einstellungen eines Telemedizin-Anbieters aktualisieren |
GET | /audit-logs | Audit-Log-Einträge der Organisation auflisten (Audit-Log) |
GET | /skus/{sku_uid}/telemedicine-provider-skus | Telemedizin-Verknüpfungen einer SKU auflisten |
POST | /skus/{sku_uid}/telemedicine-provider-skus | Eine Telemedizin-SKU-Verknüpfung anlegen |
GET | /skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid} | Eine Telemedizin-SKU-Verknüpfung abrufen |
PATCH | /skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid} | Eine Verknüpfung aktualisieren, inklusive Pausieren und Fortsetzen |
DELETE | /skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid} | Eine Telemedizin-SKU-Verknüpfung löschen |
Erforderliche Berechtigungen
| Endpoint | Erforderliche Berechtigung |
|---|---|
| Bestellungen anzeigen | order:read |
| Bestellungen anlegen/aktualisieren/stornieren (Bestellerfassung) | order:write |
| Rezepte und Rezeptstatistiken anzeigen | prescription:read |
| Produkte / SKUs / Shop-SKUs / Shop-Produkte auflisten | product:read |
| Produkte / SKUs / Shop-SKUs / Shop-Produkte anlegen, aktualisieren oder löschen | product:write |
| Fragebögen auflisten / anzeigen (Fragebögen) | questionnaire:read |
| Fragebögen anlegen und das SurveyJS-Modell veröffentlichen | questionnaire:write |
| Ärzte auflisten | doctor:read |
| Arztstatistiken | doctor_statistics:read |
| Dashboard-Statistiken der Organisation, Statistiken aller Ärzte, Fragebogen-Einreichungsstatistiken (Statistiken) | statistics:read |
| Gesperrte SKUs eines Arztes auflisten | doctor_blacklist:read |
| SKU für einen Arzt sperren / freigeben | doctor_blacklist:write |
| Patienten anzeigen | patient:read |
| Wartezimmer registrieren / stornieren | waiting_room:write |
| Wartezimmerstatus anzeigen | waiting_room:read |
| Prüf-Links erstellen / widerrufen | review_link:write |
| Prüf-Links auflisten | review_link:read |
| Wallet-Pass-Vorlagen auflisten | wallet_pass_template:read |
| Wallet Passes auflisten / abrufen | wallet_pass:read |
| Wallet Pass ausstellen / widerrufen | wallet_pass:write |
| Gescannten Wallet Pass verifizieren | wallet_pass:verify |
| Push-Benachrichtigungen senden | wallet_pass_push_notification:write |
| Listing-Anfragen auflisten / anzeigen | listing_request:read |
| Listing-Anfragen annehmen / ablehnen | listing_request:write |
Termindaten lesen (alle GET-Endpoints unter scheduling) | scheduling:read |
Termindaten ändern (alle POST- / PATCH- / DELETE-Endpoints unter scheduling) | scheduling:admin |
| Anamnese-Einreichung mit einem Patienten verknüpfen | anamnesis:connect_patient |
| Review-Anfragen erstellen / stornieren | review_request:write |
| Review-Anfrage abrufen | review_request:read |
| Telemedizin-Anbieter auflisten, Einstellungen ansehen, SKU-Verknüpfungen auflisten oder abrufen | telemedicine_provider:read |
| Einstellungen aktualisieren; SKU-Verknüpfungen anlegen, ändern, pausieren, fortsetzen oder löschen | telemedicine_provider:write |
| Audit-Log der Organisation auflisten | audit_log:read |
Webhook-Abonnement-Endpoints (notification-subscriptions) erfordern keine spezifische Berechtigung über einen gültigen Management-API-Schlüssel hinaus.