Comandes de kits de prova a casa
Envia els resultats per correu electrònic
Avisa el client per correu electrònic que els resultats de laboratori del seu kit de prova a casa estan a punt
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"
}
Envia al client un correu electrònic per avisar-lo que els seus resultats de laboratori ja estan
a punt. El correu s’envia a l’
email del perfil de la comanda de kit de prova a casa.
El correu electrònic fa servir la marca genèrica del soci: el nom i el logotip del grup de
perfils principal del perfil. És en el language del perfil, en anglès per defecte.
Defineix with_reports com a true per adjuntar els informes de laboratori del kit. El correu
adjunta tots els informes que el client pot veure a l’app. Defineix-lo com a false per
enviar només l’avís. Afegeix note per mostrar una nota personal al correu, de com a màxim 1.000 caràcters.
Cada informe adjunt és un PDF xifrat amb AES-256. La contrasenya és el camp date_of_birth del
perfil en 8 dígits, DDMMYYYY, sense punts: un client nascut l’1 de febrer de 1985 escriu
01021985. El correu indica aquest format al client, però mai la data de naixement en si.
Cada crida envia un correu electrònic. Les crides no es dedupliquen: si crides l’endpoint dues vegades, el client
rep dos correus electrònics.
El correu electrònic no s’envia quan:
- Encara no ha arribat cap informe de laboratori.
- El perfil no té adreça electrònica o només té una adreça provisional
@aniva.email. - El perfil té desactivats els correus transaccionals. Per tornar-los a activar, defineix
transactional_emails_enabledcom atrueamb Actualitza el perfil. with_reportséstruei el perfil no tédate_of_birth. Defineix-la amb Actualitza el perfil o envia’l ambwith_reports: false.- La comanda és una de les comandes de demostració de kits de prova a casa. Una comanda de demostració no té cap client a qui enviar el correu.
results_view i l’àmbit home_kit_orders_view o home_kit_orders_manage.
Sol·licitud
Paràmetres de ruta
Identificador únic (UUID) de la comanda de kit de prova a casa de la qual vols enviar els resultats per correu.
Paràmetres del cos
true adjunta els informes de laboratori com a fitxers PDF protegits amb contrasenya. false envia només l’avís que els resultats estan
a punt.Resposta
En cas d’èxit, l’API retorna200 OK.
Respostes d’error
El cos d’un error contéerror, un missatge llegible per a humans, i reason, un codi estable. Els errors de validació
i la falta de l’àmbit results_view no tenen reason.
| Estat | Motiu | Descripció |
|---|---|---|
400 | — | Error de validació — ID no vàlid, falta with_reports o note supera els 1.000 caràcters. |
403 | access_denied | Prohibit — la teva clau API no té aquests àmbits o la comanda de kit de prova a casa queda fora del teu context d’accés. |
404 | not_found | No s’ha trobat la comanda de kit de prova a casa. |
409 | demo_order | La comanda és una comanda de demostració de kit de prova a casa. No té cap client a qui enviar el correu. |
409 | no_reports | Encara no ha arribat cap informe de laboratori. |
409 | no_email | El perfil no té adreça electrònica. |
409 | placeholder_email | El perfil només té una adreça provisional @aniva.email. Actualitza el perfil amb un correu real. |
409 | unsubscribed | El perfil té desactivats els correus transaccionals. Primer defineix transactional_emails_enabled com a true. |
409 | no_birthdate | with_reports és true i el perfil no té date_of_birth, la contrasenya del PDF. |
413 | reports_too_large | Els informes són massa grans per a un sol correu. Envia el correu amb with_reports: false. |
422 | report_unprotectable | Un informe no és un PDF o no s’ha pogut protegir amb contrasenya. Envia’l amb with_reports: false. |
500 | — | Error intern del servidor. |
502 | report_unavailable | No s’ha pogut carregar un informe de laboratori. No s’ha enviat cap correu. |
502 | send_failed | El proveïdor de correu ha rebutjat el correu. No s’ha enviat cap correu. |
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"
}