Généralités
API REST
Le logiciel SADV est accessible via une API REST. Une API REST est une interface web qui expose des ressources et des opérations via HTTP. Concrètement, votre logiciel envoie des requêtes HTTP à des endpoints de l’API (avec des données JSON) et reçoit des réponses JSON en retour.
Support technique
Le support technique SADV est destiné aux équipes qui intègrent l’API dans un logiciel client.
Pour ouvrir une demande, envoyez un message à developers@syadem.com.
Le support technique couvre l’accès API, l’authentification et l’analyse des erreurs d’intégration.
Politique de mise à jour de l’API
L’API SADV suit un versionnement sémantique (SemVer), basé sur trois niveaux : majeure, mineure et corrective. En pratique, une version mineure ajoute des capacités compatibles, et une version corrective corrige un comportement sans modifier le contrat attendu par votre intégration.
SADV étant fourni en mode SaaS, des mises à jour sont déployées régulièrement pour améliorer les fonctionnalités et corriger les anomalies.
Syadem s’engage à maintenir la compatibilité ascendante de l’API : les intégrations existantes ne sont pas cassées par les mises à jour mineures et correctives.
Si une évolution non rétrocompatible est nécessaire, elle est publiée en version majeure. Vous êtes informés à l’avance, accompagnés dans la transition, et la version candidate est mise à disposition en pré-production pendant un délai de prévenance communiqué en amont, afin que vous puissiez tester et ajuster votre intégration avant le déploiement en production.
Appel de l’API SADV
Vous pouvez appeler l’API SADV de deux manières :
- En utilisant une librairie cliente
sadv-client, qui gère la construction des requêtes HTTP et l’interprétation des réponses JSON. - En appelant vous-même l’API via HTTP, en suivant la spécification OpenAPI.
L’endpoint principal de l’API SADV est /diagnostic_for_patient, qui reçoit les données d’entrée du patient et retourne des recommandations de vaccination.
Nomenclature NUVA
NUVA sert à structurer l’historique vaccinal (par exemple les identifiants utilisés dans prevention_acts).
Cette nomenclature est intégrable à l’aide d’une librairie cliente.
Nomenclature VaccinationProfile
VaccinationProfile sert à structurer le profil santé (champ conditions) avec des conditions typées (booléen, date, entier, etc.).
Cette nomenclature est intégrable à l’aide d’une librairie cliente.
Étape suivante
Configurez l’instance SADV à utiliser (territoire, environnement, URL de base) avant le premier appel API.