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 points d’accès 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. Le format de version est MAJOR.MINOR.PATCH :

  • MAJOR : évolution non rétrocompatible.
  • MINOR : ajout de fonctionnalités compatibles avec les intégrations existantes.
  • PATCH : correction sans changement de comportement attendu pour l’intégration.

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, vous serez informés à l’avance et accompagnés dans la transition. La nouvelle version sera mise à disposition en environnement d’intégration 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.

Intégration de l’API SADV

Vous pouvez intégrer l’API SADV de deux manières :

  1. En utilisant une librairie cliente sadv-client, qui gère la construction des requêtes HTTP et l’interprétation des réponses JSON.
  2. En appelant directement l’API en HTTP, selon la spécification OpenAPI.

Quel que soit le mode choisi, le point d’accès API principal est /diagnostic_for_patient, qui reçoit les données patient et retourne des recommandations de vaccination.

Nomenclatures utilisées par l’API

L’API s’appuie sur deux nomenclatures complémentaires pour structurer les données d’entrée :

  • NUVA : structure l’historique vaccinal, notamment via les identifiants utilisés dans prevention_acts.
  • VaccinationProfile : structure le profil santé via le champ conditions, avec des types de données explicites (booléen, date, entier, etc.).

Pour l’intégration :

Liens utiles

Étape suivante

Configurez l’instance SADV à utiliser (territoire, environnement, URL de base) avant le premier appel API.