ApiBorne
Sommaire du guide

Statut d'un RDV

L'unique écriture du Cockpit ApiBorne dans votre système : refléter un accueil au guichet (inCare) ou une fin de prise en charge (done). Votre agenda reste la source de vérité.

PUT/appointments/{appointmentId}/status
Base : {editorBaseUrl}/api/apiborneIntegrationService/v1Auth : X-Kiosk-Auth-Key seuleRoute obligatoire

Pourquoi cette route existe

Sans elle, le Cockpit serait une impasse : le personnel d'accueil y voit les arrivées et appelle les patients, mais rien ne redescendrait dans votre agenda. Cette route est l'unique écriture d'ApiBorne chez vous — refléter la prise en charge (inCare) et la fin de prise en charge (done) pour que vos écrans et votre planning restent justes, sans double saisie au guichet.

Séquence : clic « Prise en charge » au Cockpit, le serveur ApiBorne écrit le statut inCare sur le RDV chez l'éditeur ; progression avant uniquement, idempotente.Cockpit ApiBornepersonnel d'accueilServeur ApiBorneVotre systèmeagendaclic « Prise en charge »(ou « Terminé » en fin de parcours)PUT /appointments/{id}/status { "status": "inCare" }X-Kiosk-Auth-Key seule — pas de device id200 { "status": "inCare" }votre agenda reflète l'étatprogression avant uniquementdéjà à l'état demandé ou au-delà → 200 sans effet (idempotent)C'est la SEULE écriture d'ApiBorne chez vous
L'unique écriture d'ApiBorne dans votre système : votre agenda reste la source de vérité, le Cockpit ne fait que refléter l'accueil.

Sémantique

  • États cibles : checkedIn, inCare, done — progression uniquement vers l'avant.
  • RDV déjà à l'état demandé ou au-delà → appel idempotent, 200 sans effet.
  • RDV annulé ou déjà terminé → 400 VALIDATION_ERROR.

Requête

bash
curl -sS -X PUT "$BASE/appointments/apt-1001/status" \
  -H "X-Kiosk-Auth-Key: $KEY" -H 'Content-Type: application/json' \
  -d '{ "status": "inCare" }'
# → 200 { "status": "inCare" }

Points d'attention

L'appel vient du serveur ApiBorne, pas d'une borne : seul X-Kiosk-Auth-Key est requis (comme staff/sign-in), la clé devant correspondre à l'établissement du RDV.

Implémentation de référence

src/app/api/apiborneIntegrationService/v1/appointments/[appointmentId]/status/route.ts → — garde forward-only et idempotence en une vingtaine de lignes.