Commandes de kits à domicile
Envoyer les résultats par e-mail
Prévenir le client par e-mail que les résultats de laboratoire de son kit à domicile sont prêts
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
Envoie au client un e-mail l’informant que ses résultats de laboratoire sont prêts. L’e-mail est envoyé à l’adresse
email du profil de la commande de kit à domicile.
L’e-mail utilise une identité visuelle partenaire générique : le nom et le logo du groupe de
profils principal du profil. Il est dans la language du profil, en anglais par défaut.
Définis with_reports sur true pour joindre les rapports de laboratoire du kit. L’e-mail
joint chaque rapport que le client peut voir dans l’application. Définis-le sur false pour
n’envoyer que la notification. Ajoute note pour afficher une note personnelle dans l’e-mail, de 1 000 caractères maximum.
Chaque rapport joint est un PDF chiffré en AES-256. Le mot de passe est la date_of_birth du
profil sous forme de 8 chiffres, DDMMYYYY, sans points : un client né le 1er février 1985 saisit
01021985. L’e-mail indique ce format au client, mais jamais la date de naissance elle-même.
Chaque appel envoie un e-mail. Les appels ne sont pas dédupliqués : si tu appelles le point de terminaison deux fois, le client
reçoit deux e-mails.
L’e-mail n’est pas envoyé lorsque :
- Aucun rapport de laboratoire n’est encore arrivé.
- Le profil n’a pas d’adresse e-mail, ou uniquement une adresse fictive
@aniva.email. - Le profil a désactivé les e-mails transactionnels. Pour les réactiver, définis
transactional_emails_enabledsurtrueavec Mettre à jour le profil. with_reportsvauttrueet le profil n’a pas dedate_of_birth. Définis-la avec Mettre à jour le profil, ou envoie avecwith_reports: false.- La commande fait partie des commandes de kit à domicile de démonstration. Une commande de démonstration n’a pas de client à qui envoyer d’e-mail.
results_view ainsi que le scope home_kit_orders_view ou home_kit_orders_manage.
Requête
Paramètres de chemin
Identifiant unique (UUID) de la commande de kit à domicile dont les résultats doivent être envoyés par e-mail.
Paramètres du corps
true joint les rapports de laboratoire sous forme de fichiers PDF protégés par mot de passe. false envoie uniquement la notification indiquant que les résultats sont
prêts.Réponse
En cas de succès, l’API renvoie200 OK.
Réponses d’erreur
Un corps d’erreur contienterror, un message lisible par un humain, et reason, un code stable. Les erreurs de validation
et l’absence du scope results_view n’ont pas de reason.
| Statut | Raison | Description |
|---|---|---|
400 | — | Erreur de validation — identifiant invalide, with_reports manquant ou note dépassant 1 000 caractères. |
403 | access_denied | Accès refusé — ta clé API n’a pas les scopes requis, ou la commande de kit à domicile est en dehors de ton contexte d’accès. |
404 | not_found | Commande de kit à domicile introuvable. |
409 | demo_order | La commande est une commande de kit à domicile de démonstration. Elle n’a pas de client à qui envoyer d’e-mail. |
409 | no_reports | Aucun rapport de laboratoire n’est encore arrivé. |
409 | no_email | Le profil n’a pas d’adresse e-mail. |
409 | placeholder_email | Le profil n’a qu’une adresse fictive @aniva.email. Mets à jour le profil avec une vraie adresse e-mail. |
409 | unsubscribed | Le profil a désactivé les e-mails transactionnels. Définis d’abord transactional_emails_enabled sur true. |
409 | no_birthdate | with_reports vaut true et le profil n’a pas de date_of_birth, qui sert de mot de passe au PDF. |
413 | reports_too_large | Les rapports sont trop volumineux pour un seul e-mail. Envoie l’e-mail avec with_reports: false. |
422 | report_unprotectable | Un rapport n’est pas un PDF, ou n’a pas pu être protégé par mot de passe. Envoie avec with_reports: false. |
500 | — | Erreur interne du serveur. |
502 | report_unavailable | Impossible de charger un rapport de laboratoire. Aucun e-mail n’a été envoyé. |
502 | send_failed | Le fournisseur d’e-mails a refusé l’e-mail. Aucun e-mail n’a été envoyé. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}