Demandes de partage

Format du code de partage permanent : constitué de 8 chiffres et lettres aléatoires (séparés au 4ème caractère par un tiret)
Format du code de partage temporaire : 5 chiffres ou lettres aléatoires
Code de partage permanent du compte de test : U4XV-L7JL
Nous vous encourageons à utiliser ce code pour tester les fonctionnalités de partage de données de MesVaccins.net.

Pour en savoir plus, voir la distinction entre codes de partage temporaire et permanent dans le manuel.

Lecture des carnets associés à un code de partage

  • GET /accesses/:access_code/records.json renvoie la liste des carnets pour lesquels le professionnel de santé peut faire une demande de partage.

:access_code est soit un code de partage permanent (8 caractères), soit un code de partage temporaire (5 caractères).

Par exemple, appeler ce service avec le code de partage permanent du compte de test renvoie 200 OK avec en corps de réponse les données suivantes :

Requête : GET /accesses/U4XV-L7JL/records.json
[
	{
		"uuid": "1bac1164-f7ce-43a7-9e7f-0f8b9958c3df",
		"nickname": "Sylvie"
	},
	{
		"uuid": "843b1250-5f56-4c6c-ad64-eb87353f8138",
		"nickname": "Kevin"
	}
]

Une date de naissance peut être spécifiée :

  • GET /accesses/:access_code/records.json?birth_date=:birth_date renvoie le carnet correspondant à la date de naissance donnée.

Exemple : appeler ce service avec le code de partage ainsi que la date de naissance de Sylvie du compte de test renvoie 200 OK avec en corps de réponse les données suivantes :

Requête : GET /accesses/U4XV-L7JL/records.json?birth_date=2005-04-12
[
	{
		"uuid": "88192142-7cee-4f4a-82c2-4080048e1e7e",
		"nickname": "Ambroise"
	}
]

En cas de code de partage incorrect, le serveur renvoie 404 Not Found.

Demande d’accès à un carnet

  • PUT /accesses/:access_code/records/:uuid.json fait une demande d'accès à un carnet de vaccination. Le corps de la requête doit contenir la date de naissance du carnet visé :
{
	"birth_date": "1945-01-01"
}
Pour faciliter les tests, vous pouvez utiliser le carnet Ambroise dont la date de naissance est 12/04/2005.

En cas de succès, le serveur renvoie 200 OK avec en corps de réponse le carnet visé (voir la section Carnets de vaccinations pour en savoir plus sur le format de données).

En cas de code de partage ou d’UUID incorrect, le serveur renvoie 404 Not Found.

En cas de date de naissance incorrecte, le serveur renvoie 400 Bad Request.

Envoi d’un code de partage temporaire au patient

Dans le cas où le patient a oublié son code de partage, un code de partage temporaire peut lui être généré et envoyé sur demande du professionnel de santé. Une fois transmis par le patient au professionnel de santé, ce code permet d’obtenir l’autorisation d’accéder aux carnets gérés par le patient.

  • POST /accesses/send_access_code.json génère et envoie au patient un code de partage temporaire par e-mail et sms
Pour information, le format du code de partage temporaire est le suivant : 5 chiffres ou lettres aléatoires.

Par exemple, appeler ce service avec pour corps de requête :

{
    "contact": "[donnée-identifiante]"
}

[donnée-identifiante] peut être :

  • l’e-mail du compte patient ;
  • le numéro de téléphone mobile du compte patient ;
  • le code ins-c d’un des carnets du compte patient (récupéré au niveau de la carte Vitale).

Le serveur renvoie 200 OK avec en corps de réponse les canaux sur lesquels le message a été expédié :

{
	"sms": true,
	"email": false
}

En cas d’information de contact non trouvée (ou invalide), le serveur renvoie 404 Not Found (respectivement 400 Bad Request) avec l’erreur dans le corps de la réponse.