ApiBorne
Sommaire du guide

Référentiel : types de documents

LE référentiel derrière les documents requis — il vous appartient.

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

Pourquoi cette route existe

LE référentiel derrière les documents requis : cette liste fait foi pour les requiredDocumentTypes des RDV et le documentType des uploads. Reprenez le vocabulaire standard du contrat (41 codes) pour tout type qui y correspond — c'est lui qui rend les configurations interopérables — et ajoutez librement vos codes maison.

Elle ne sert qu'à CONSTRUIRE la liste de la page « Paramètres des documents requis » de l'admin ApiBorne : le libellé personnalisé et « fournissable depuis le téléphone » s'y redéfinissent ensuite, pour chaque entrée de VOTRE liste. Route recommandée mais hors sonde : sans elle, l'admin se limite au vocabulaire standard.

Séquence : l'admin ouvre la page Paramètres des documents requis, le serveur ApiBorne récupère votre référentiel /config/document-types et construit la liste ; libellé personnalisé et « sur téléphone » se définissent ensuite dans l'admin, pas chez vous.Votre système/config/document-typesServeur ApiBorneAdmin ApiBorneDocuments requisouvre « Paramètres des documents requis »GET /config/document-typesX-Kiosk-Auth-Key{ "documentTypes": [{ documentType, label }] }VOTRE liste — codes standard + codes maisonliste construite depuis votre référentielvos labels comme libellés par défautlibellé personnalisé + « sur téléphone »redéfinis ICI, pour chaque entrée de votre listeRoute absente ou en erreur ? Repli sur le vocabulaire standard (41 codes)recommandée mais HORS sonde — elle ne bloque jamais la configuration
Votre référentiel ne sert qu'à CONSTRUIRE la liste : la présentation à la borne (libellé personnalisé, « fournissable depuis le téléphone ») se paramètre dans l'admin ApiBorne, entrée par entrée.

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

Ce que vous devez retourner

200
{ "documentTypes": [
  { "documentType": "prescription",        "label": "Ordonnance" },
  { "documentType": "mutualInsuranceCard", "label": "Carte Mutuelle" },
  { "documentType": "preOpChecklist",      "label": "Check-list pré-opératoire (maison)" }
] }
  • documentTypecode — vocabulaire standard (41 codes) ou code propre à l'éditeur
  • labellibellé affichable par défaut (personnalisable ensuite dans l'admin ApiBorne)

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