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.

Appel de l’API SADV

Vous pouvez appeler 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.
   • Client Java
   • Client PHP
2. En appelant vous-même l’API via HTTP, en suivant la spécification OpenAPI.
   • Spécification OpenAPI

Structuration des données d’entrée

Avant d’appeler l’endpoint de diagnostic, les données d’entrée doivent être structurées à l’aide de deux nomenclatures :

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.

• Présentation NUVA
• Librairies NUVA

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.

• Présentation VaccinationProfile
• Librairie VaccinationProfile (PHP)

Étape suivante

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

• Choix de l’instance