Wallet Passes
Patient Pass ist der Produktname (Identität in der Wallet). Die Endpoints bleiben unter/wallet-passes.
Fragen Sie Vorlagen ab, stellen Sie einen Pass aus, verifizieren Sie einen Scan und senden Sie Push-Benachrichtigungen. Der Patient muss bereits Kunde des Shops sein — zuerst POST /patients, dann POST /wallet-passes. Siehe Patient Pass.
Vorlagen auflisten
Rufen Sie Wallet-Pass-Vorlagen für einen bestimmten Shop ab.wallet_pass_template:read
Beispielanfrage
Antwort
Wallet Passes auflisten
Rufen Sie Wallet Passes für eine bestimmte Shop-Kunden- und Shop-Kombination ab.wallet_pass:read
Beispielanfrage
Antwort
total ist die Anzahl der Pässe in data — dieser Endpoint gibt alle passenden Pässe in
einer Antwort zurück und ist nicht paginiert, enthält also weder totalRegistries noch
totalPages.Das Wallet-Pass-Objekt
Wallet-Pass erstellen
shop_customer_id zusammen mit dem shop_identifier identifiziert —
Sie müssen also vorher keine RxScale-Patienten-UID auflösen.
Erforderliche Berechtigung: wallet_pass:write
Anfragekörper
UID der Vorlage, aus der ausgestellt werden soll. Abrufbar über
GET /wallet-passes/templates.Optionales Kalenderdatum, an dem dieser Pass ablaufen soll, im Format
YYYY-MM-DD. Weglassen, um die Vorlagen-Vorgabe zu übernehmen (festes Datum, Gültigkeit in Tagen ab Ausstellung oder kein Ablauf). Wird nur bei der ersten Erstellung gesetzt — das Aktualisieren eines bestehenden Passes ändert expires_at nicht.Beispielanfrage
Antwort
Gibt das Wallet-Pass-Objekt zurück.Der Statuscode sagt Ihnen, ob ein Pass neu erstellt oder wiederverwendet wurde. Dieser
Endpoint ist idempotent pro Patient und Vorlage:
201 bedeutet, dass ein neuer Pass
ausgestellt wurde, 200 bedeutet, dass der Patient für diese Vorlage bereits einen Pass
hatte und dieser aktualisiert und zurückgegeben wurde. Ein zweiter Aufruf gibt dem
Patienten keine zwei Pässe.ios_download_url bzw. android_download_url an den Patienten weiter, damit er
den Pass zu seiner Wallet hinzufügen kann.
Fehlerantworten
Eine Vorlage, die ein signiertes Rezept erfordert, gibt eine spezifische Meldung zurück,
damit Sie diesen Fall von einer fehlerhaften Anfrage unterscheiden können:
Wallet-Pass abrufen
deleted_at ist null).
Erforderliche Berechtigung: wallet_pass:read
Beispielanfrage
Antwort
Gibt das Wallet-Pass-Objekt zurück.Fehlerantworten
Wallet-Pass löschen
deleted_at wird gesetzt, sodass das Scannen eines widerrufenen Passes weiterhin auflöst —
POST /wallet-passes/verify antwortet dann mit "valid": false und "status": "revoked"
statt mit einem 404.
Erforderliche Berechtigung: wallet_pass:write
Beispielanfrage
Antwort
204 No Content mit leerem Körper.
Fehlerantworten
Gescannten Pass verifizieren
Ordnet einen gescannten Patient Pass shop-bezogenen Identitäts-Handles zu. Erfordert einen API-Schlüssel mit der Berechtigungwallet_pass:verify.
wallet_pass:verify
Anfragekörper
Der Wert, der im Pass-Barcode kodiert ist. Behandeln Sie ihn wie ein Zugangsgeheimnis und senden Sie ihn im Body, niemals in einer URL.
Beispielanfrage
Antwort (200)
Ein abgelaufener Pass liefert HTTP
200 mit "valid": false, "status": "expired" und "expired": true, enthält aber weiterhin wallet_pass_uid, patient_profile_uid und shop_customer_id, sofern vorhanden. Ein widerrufener Pass liefert "valid": false mit "status": "revoked"; ist ein Pass sowohl widerrufen als auch über sein Ablaufdatum hinaus, ist "status" "revoked". shop_customer_id fehlt bei Passes, die vor der Shop-Kunden-Anforderung ausgestellt wurden.
Dieser Endpoint liefert ausschliesslich Identitäts-Handles. Die Details der Patientin oder des Patienten laden Sie über GET /v1/management/patients.
Fehlerantworten
Push-Benachrichtigungen senden
Senden Sie Push-Benachrichtigungen an einen oder mehrere Wallet-Pass-Inhaber. Akzeptiert einen Stapel von Benachrichtigungen.wallet_pass_push_notification:write