Envoi de requêtes

Le logiciel métier prend l’initiative de l’ensemble des requêtes envoyées. Le protocole de communication est HTTPS sur le serveur de production.

Urls des endpoints

Serveur de production
Toutes les URLs commencent par https://www.mesvaccins.net/api/v1.
Serveur de test
Toutes les URLs commencent par https://test.mesvaccins.net/api/v1

Chaque requête envoyée à MesVaccins.net vise une ressource, au sens d’une ressource dans une architecture REST.

Configuration des end-points

Les adresses suivantes nécessitent d’être joignables, ce qui peut impliquer une configuration des éventuels firewalls :

IP Port Description
185.49.208.199 443 Proxy MesVaccins.net de test
185.49.208.14 443 Proxy MesVaccins.net de production
185.49.208.96 443 Proxy MesVaccins.net de production
185.49.208.251 443 Service MesVaccins.net de test
185.49.208.249 443 Service MesVaccins.net de production
185.49.208.195 443 Service d’authentification MesVaccins.net de test
185.49.208.18 443 Service d’authentification MesVaccins.net de production

Cas spécifique des verbes HTTP PUT et DELETE

Les verbes HTTP PUT et DELETE sont filtrés par les serveurs proxy en amont de notre API. De ce fait, toute requête utilisant ces verbes doit être envoyée avec le verbe POST, en précisant le verbe ciblé dans l’entête HTTP X-Http-Method-Override. Exemple :

POST /accesses/:access_code/records/:uuid.json
Host: test-pro.mesvaccins.net
Authorization: [authentification basique de l'application cliente]
X-Http-Method-Override: PUT

Format des requêtes

Les données sont échangées au format JSON. Le header suivant devra donc être utilisé dans les requêtes envoyant des données en POST ou PUT dans le corps de la requête : Content-Type: application/json; charset=utf-8.

Toutes les URLs de services finissent en .json pour indiquer que les données émises et reçues sont au format JSON.

Toutes les dates sont représentées par des chaînes de caractère au format ISO 8601.

Toutes les chaînes de caractère sont encodées en UTF-8.

Internationalisation (I18n)

Le paramètrage de la langue des messages générés par l’API et le système expert MesVaccins.net est effectué en assignant le header Accept-Language avec la locale attendue. Par défaut, l’API considére le client comme utilisant la locale fr_FR.

L’API supporte les locales suivantes :

Locale Statut
fr_FR Par défaut
de_BE En cours de support
fr_BE Supportée
nl_BE En cours de support

API grand public et API professionnelle

L’API se décline en deux variantes, l’une à destination du grand public, l’autre à destination des professionnels de santé. Afin de garantir la confidentialité des données de santé, il n’est pas possible d’accéder aux données nominatives via l’API grand public.