ApiBorne
Sommaire du guide

Référentiel : lieux

Sites / zones d'accueil de l'établissement.

GET/config/office-places
Base : {editorBaseUrl}/api/apiborneIntegrationService/v1Auth : X-Kiosk-Auth-Key seule

Pourquoi cette route existe

Les lieux structurent tout le paramétrage : chaque borne est rattachée à un ou plusieurs lieux dans l'admin ApiBorne, chaque lieu porte sa propre séquence de tickets (avec un décalage configurable pour éviter les collisions de numéros entre sites), et les réglages d'accueil peuvent être ciblés par site.

C'est aussi le référentiel du contrôle « mauvais lieu » : au check-in, la borne compare le locationId du RDV aux lieux qui lui sont rattachés et prévient le patient qui se trompe de site. L'id que vous servez ici doit donc être EXACTEMENT celui que portent vos RDV (locationId) sur les routes de communication.

Structure : chaque borne est rattachée à un ou plusieurs lieux ; chaque lieu porte sa séquence de tickets avec son décalage ; le lieu du RDV est contrôlé à la borne.Vos lieux (référentiel /config/office-places)Lieu 1 — « Clinique du Parc »id du référentiel /config/office-placesséquence SC-1, SC-2… (décalage 0)Lieu 2 — « Annexe Nord »id du référentiel /config/office-placesséquence SC-101, SC-102… (décalage 100)KIOSK-041borneKIOSK-042borneKIOSK-043borneune borne peut couvrir plusieurs lieuxRDV.locationId = id d'un de VOS lieuxborne d'un autre lieu → message « mauvais lieu » au patient
Le rattachement borne → lieu se fait dans l'admin ApiBorne, à partir des ids que VOUS servez sur /config/office-places — les mêmes que le locationId de vos RDV.

Comment l'appeler

L'appelant est le serveur ApiBorne — jamais une borne : un GET sous votre base contrat, authentifié par la seule clé d'autorisation compte dans X-Kiosk-Auth-Key (admin ApiBorne, page Connectivité), sans X-Kiosk-Device-Id. Il l'appelle à l'activation de l'intégration (sonde config-check) puis à chaque ouverture des pages d'admin qui s'appuient sur ce référentiel.

bash
# AUTH_KEY = la clé d'autorisation compte (admin ApiBorne, page Connectivité)
# L'appelant est le serveur ApiBorne — jamais une borne
curl -sS "$EDITEUR/api/apiborneIntegrationService/v1/config/office-places" \
  -H "X-Kiosk-Auth-Key: $AUTH_KEY"

Ce que vous devez retourner

200
{ "officePlaces": [
  { "id": "1", "name": "Clinique du Parc" },
  { "id": "2", "name": "Annexe Nord" }
] }
  • ididentifiant opaque, stable — le même que le locationId des RDV du contrat
  • namelibellé affiché dans l'admin et sur la borne (contrôle de lieu)

Toujours un 200 avec l'enveloppe ci-dessus — liste vide acceptée (établissement neuf). Schéma complet dans le swagger des routes de configuration.

Implémentation de référence