ApiBorne
Sommaire du guide

Routes de communication

Les opérations que la borne appelle chez vous pendant le parcours patient — une page par opération : sémantique, requête, réponse, erreurs et implémentation de référence. Les 12 routes sont toutes obligatoires ; celles dont vous n'avez pas la fonctionnalité acceptent une implémentation minimale (liste vide, 204, 404…).

Les 12 opérations

POST/patients/identify

Identifier un patientRecherche les patients et leurs RDV du jour (carte de santé ou saisie).

GET/appointments/by-code/{code}

RDV par code (QR)Résout le code de convocation scanné par le patient.

GET/appointments/{appointmentId}

RDV par identifiantRechargement canonique d'un RDV déjà connu.

PUT/appointments/{appointmentId}/status

Statut d'un RDVLe Cockpit ApiBorne reflète un changement d'état dans votre agenda.

PATCH/patients/{patientId}

Modifier un patientCorrection des données administratives depuis la borne.

PUT/appointments/{appointmentId}/prescriber

Prescripteur du RDVLe patient valide un prescripteur proposé par l'analyse d'ordonnance.

GET/appointments/{appointmentId}/documents

Lister les documentsDocuments présents et types attendus — la borne calcule les manquants.

POST/appointments/{appointmentId}/documents

Téléverser un documentPages images en base64, analyse d'ordonnance optionnelle en retour.

DELETE/appointments/{appointmentId}/documents/{documentId}

Supprimer un documentLe remplacement d'un document = DELETE de l'ancien puis POST du nouveau.

POST/appointments/{appointmentId}/check-in

Check-inL'opération critique : arrivée du patient, ticket d'appel en retour.

GET/appointments/{appointmentId}/notification-readiness

Notification readinessLe dossier est-il complet au sens de l'éditeur ? Toujours répondre.

POST/staff/sign-in

Connexion du personnelLogin Cockpit avec vos identifiants — appelé par le serveur ApiBorne.

La spécification OpenAPI

La source de vérité normative est openapi.yaml (OpenAPI 3.0.3). Ce guide en reprend la sémantique — en cas de doute, la spec fait foi. Les fichiers se branchent directement sur vos outils (générateurs de clients, Postman, Insomnia, Swagger UI…).

La variante JSON est générée automatiquement depuis le YAML à chaque build — les deux fichiers sont strictement équivalents.