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://pro-secure.mesvaccins.net/mvx_api/v1.

Serveur de test

Toutes les URLs commencent par https://test-pro-secure.mesvaccins.net/mvx_api/v1

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

Support de SNI

Nos serveurs de test nécessitent le support de l’extension SNI du protocole TLS. Toutes les versions des technologies & frameworks ne supportent pas SNI, il est donc nécessaire de faire cette vérification en amont de tout développement.

Le support de SNI dans la technologie Java commence avec la version 1.7.

Configuration des end-points

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

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 :