Mājas testa komplektu pasūtījumi
Nosūtīt rezultātus e-pastā
Nosūtīt klientam e-pastu, ka mājas testa komplekta laboratorijas rezultāti ir gatavi
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"
}
Nosūti klientam vienu e-pastu, kas informē, ka viņa laboratorijas rezultāti ir gatavi. E-pasts tiek nosūtīts uz
mājas testa komplekta pasūtījuma profila
email.
E-pastā izmantots vispārīgs partnera zīmola noformējums: profila galvenās profilu grupas
nosaukums un logotips. Tas ir profila language valodā, pēc noklusējuma angļu valodā.
Iestati with_reports uz true, lai pievienotu komplekta laboratorijas pārskatus. E-pastā
tiek pievienoti visi pārskati, kurus klients redz lietotnē. Iestati to uz false, lai
nosūtītu tikai paziņojumu. Pievieno note, lai e-pastā rādītu personisku piezīmi, ne vairāk kā 1 000 rakstzīmju.
Katrs pievienotais pārskats ir PDF fails, kas šifrēts ar AES-256. Parole ir profila date_of_birth
kā 8 cipari, DDMMYYYY, bez punktiem: klients, kurš dzimis 1985. gada 1. februārī, ievada
01021985. E-pastā klientam ir norādīts šis formāts, bet nekad pats dzimšanas datums.
Katrs izsaukums nosūta vienu e-pastu. Izsaukumi netiek deduplicēti: ja izsauc galapunktu divreiz, klients
saņem divus e-pastus.
E-pasts netiek nosūtīts, ja:
- Vēl nav saņemts neviens laboratorijas pārskats.
- Profilā nav e-pasta adreses vai ir tikai pagaidu
@aniva.emailadrese. - Profilā ir izslēgti transakciju e-pasti. Lai tos atkal ieslēgtu, iestati
transactional_emails_enableduztrue, izmantojot Atjaunināt profilu. with_reportsirtrue, un profilā navdate_of_birth. Iestati to ar Atjaunināt profilu vai nosūti arwith_reports: false.- Pasūtījums ir viens no demo mājas testa komplektu pasūtījumiem. Demo pasūtījumam nav klienta, kam nosūtīt e-pastu.
results_view tvērums, kā arī home_kit_orders_view vai home_kit_orders_manage tvērums.
Pieprasījums
Ceļa parametri
Unikāls identifikators (UUID) mājas testa komplekta pasūtījumam, kura rezultātus nosūtīt e-pastā.
Pieprasījuma satura parametri
true pievieno laboratorijas pārskatus kā ar paroli aizsargātus PDF failus. false nosūta tikai paziņojumu, ka rezultāti ir
gatavi.Atbilde
Veiksmes gadījumā API atgriež200 OK.
Kļūdu atbildes
Kļūdas atbildes saturā irerror (cilvēkam lasāms ziņojums) un reason (stabils kods). Validācijas kļūdām
un trūkstošam results_view tvērumam nav reason.
| Statuss | Iemesls | Apraksts |
|---|---|---|
400 | — | Validācijas kļūda — nederīgs ID, trūkst with_reports, vai note ir garāka par 1 000 rakstzīmēm. |
403 | access_denied | Aizliegts — tavai API atslēgai nav nepieciešamo tvērumu, vai mājas testa komplekta pasūtījums ir ārpus tava piekļuves konteksta. |
404 | not_found | Mājas testa komplekta pasūtījums nav atrasts. |
409 | demo_order | Pasūtījums ir demo mājas testa komplekta pasūtījums. Tam nav klienta, kam nosūtīt e-pastu. |
409 | no_reports | Vēl nav saņemts neviens laboratorijas pārskats. |
409 | no_email | Profilā nav e-pasta adreses. |
409 | placeholder_email | Profilā ir tikai pagaidu @aniva.email adrese. Atjaunini profilu ar īstu e-pasta adresi. |
409 | unsubscribed | Profilā ir izslēgti transakciju e-pasti. Vispirms iestati transactional_emails_enabled uz true. |
409 | no_birthdate | with_reports ir true, un profilā nav date_of_birth, kas ir PDF parole. |
413 | reports_too_large | Pārskati ir pārāk lieli vienam e-pastam. Nosūti e-pastu ar with_reports: false. |
422 | report_unprotectable | Pārskats nav PDF fails vai to nevarēja aizsargāt ar paroli. Nosūti ar with_reports: false. |
500 | — | Iekšēja servera kļūda. |
502 | report_unavailable | Neizdevās ielādēt laboratorijas pārskatu. E-pasts netika nosūtīts. |
502 | send_failed | E-pasta pakalpojumu sniedzējs noraidīja e-pastu. E-pasts netika nosūtīts. |
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"
}