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 gibt Ihnen programmgesteuerten Zugang zu den Daten Ihrer Organisation in RxScale. Diese Seite bietet einen Überblick darüber, was Sie mit der API tun können, und zeigt häufige Anwendungsfälle.Übersicht
Die Management API ist für Telemedizin-Anbieter konzipiert, die:- Bestellungen und Rezepte abfragen und verwalten möchten.
- Ihren Produktkatalog und SKUs verwalten möchten.
- Auf Arzt- und Patienteninformationen zugreifen möchten.
- Wartezimmer für Videosprechstunden einrichten möchten.
- Wallet Passes zur Patientenverifizierung erstellen und verwalten möchten.
- Webhooks registrieren und verwalten möchten.
X-API-Key-Header.
Häufige Anwendungsfälle
Bestellungen verfolgen
Verwenden Sie die Bestell-Endpoints, um:- Alle Bestellungen Ihrer Organisation aufzulisten, mit Filtern nach Status, Datumsbereich und mehr.
- Detaillierte Informationen zu einer bestimmten Bestellung abzurufen, einschließlich aktuellem Status, zugehörigem Rezept und Apothekenzuweisung.
- Den Bestellfortschritt neben Webhook-Benachrichtigungen zu überwachen.
Rezepte verwalten
Verwenden Sie die Rezept-Endpoints, um:- Rezeptdetails einzusehen, einschließlich der ärztlichen Entscheidung und des Signaturstatus.
- Rezeptstatusänderungen über die Zeit zu verfolgen.
Produktverwaltung
Verwenden Sie die Produkt-Endpoints, um:- Ihre Produkte und SKUs aufzulisten.
- Produktinformationen zu aktualisieren.
- Preise und Verfügbarkeit zu verwalten.
Ärzte- und Patientenverwaltung
Verwenden Sie die Ärzte- und Patienten-Endpoints, um:- Einzusehen, welche Ärzte in Ihrer Organisation verfügbar sind.
- Auf Patientenakten und Rezepthistorien zuzugreifen.
- Patientendaten innerhalb Ihrer Organisation zu verwalten.
Wartezimmer
Verwenden Sie die Wartezimmer-Endpoints, um:- Patienten für Videosprechstunden zu registrieren.
- Die Sprechstundenwarteschlange zu verwalten.
- Patienten mit verfügbaren Ärzten zu verbinden.
Wallet Passes
Verwenden Sie die Wallet-Passes-Endpoints, um:- Digitale Wallet Passes für Patienten zu erstellen.
- Push-Benachrichtigungen über den Wallet Pass an Patienten zu senden.
- Die Patientenverifizierung mittels QR-Codes zu verwalten.
Erste Schritte mit der API
API-Schlüssel erstellen
Erstellen Sie einen API-Schlüssel im Admin Tool unter Einstellungen → API-Schlüssel. Wählen Sie die benötigten Berechtigungen (z.B.
order:read, product:read). Siehe Authentifizierung für Details.Basis-URL
Alle Anfragen gehen an die Produktions-API unter
https://api.rxscale.com. Testzugang wird über Test-Stores bereitgestellt — Anfragen gehen immer an Produktionsressourcen.Ihre erste Anfrage senden
Versuchen Sie, Ihre Bestellungen aufzulisten, um zu überprüfen, ob Ihr API-Schlüssel funktioniert:
Vollständige API-Referenz
Die vollständige Dokumentation aller Endpoints, Anfrageparameter und Antwortformate finden Sie in der Management API-Referenz.Verwandte Themen
- Management API-Referenz — Vollständige API-Dokumentation.
- Authentifizierung — Wie die API-Authentifizierung funktioniert.
- Rate Limits — Details zur API-Ratenbegrenzung.
- Webhooks und Benachrichtigungen — Echtzeit-Benachrichtigungen einrichten.