ApiBorne
Sommaire du guide

Référentiel : examens

Les examens individuels, chacun rattaché à un type.

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

Pourquoi cette route existe

Le niveau fin sous les types : un message patient ou un critère d'admission peut viser un examen précis (« SCANNER THORACIQUE ») plutôt que toute la famille. La double granularité type / examen offre les deux niveaux de ciblage dans l'admin.

L'id doit être celui de l'examId de vos RDV ; examTypeId relie chaque examen à son type parent du référentiel /config/exam-types — c'est ce lien qui permet à l'admin de filtrer les examens par famille.

Structure : chaque type d'examen (famille) amorce un préfixe de ticket et regroupe des examens ; les RDV portent examTypeId et examId, ce qui permet un ciblage par famille ou par examen précis.Vos référentiels /config/exam-types et /config/examsType — SCANNER (id 2)ticketPrefix « SC » → tickets SC-1, SC-2…Type — IRM (id 3)ticketPrefix « IR » → tickets IR-1, IR-2…SCANNER THORACIQUEid 7 — examTypeId 2SCANNER ABDOMINALid 8 — examTypeId 2IRM GENOUid 12 — examTypeId 3RDV : examTypeId = 2, examId = 7 — les mêmes ids que vos référentielsmessages patient et critères d'admission ciblables par famille OU par examen précis
Deux référentiels, deux mailles de ciblage : /config/exam-types (famille, préfixe de tickets) et /config/exams (examen précis) — reliés aux RDV par examTypeId / examId.

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/exams" \
  -H "X-Kiosk-Auth-Key: $AUTH_KEY"

Ce que vous devez retourner

200
{ "exams": [
  { "id": "7",  "name": "SCANNER THORACIQUE", "examTypeId": "2" },
  { "id": "8",  "name": "SCANNER ABDOMINAL",  "examTypeId": "2" },
  { "id": "12", "name": "IRM GENOU",          "examTypeId": "3" }
] }
  • idle même que l'examId des RDV du contrat
  • examTypeIdid du type parent (référentiel /config/exam-types)

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