Comenzi de kituri de testare la domiciliu
Trimite rezultatele prin e-mail
Anunță clientul prin e-mail că rezultatele de laborator pentru kitul său de testare la domiciliu sunt gata
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"
}
Trimite clientului un e-mail care îl anunță că rezultatele de laborator sunt gata. E-mailul este trimis la
adresa
email a profilului comenzii de kit de testare la domiciliu.
E-mailul folosește brandingul generic al partenerului: numele și logo-ul grupului principal
de profiluri al profilului. Este în limba language a profilului, implicit engleză.
Setează with_reports la true pentru a atașa rapoartele de laborator ale kitului. E-mailul
atașează fiecare raport pe care clientul îl poate vedea în aplicație. Setează-l la false pentru
a trimite doar notificarea. Adaugă note pentru a afișa o notă personală în e-mail, de cel mult 1.000 de caractere.
Fiecare raport atașat este un PDF criptat cu AES-256. Parola este date_of_birth din
profil sub formă de 8 cifre, DDMMYYYY, fără puncte: un client născut pe 1 februarie 1985 tastează
01021985. E-mailul îi comunică clientului acest format, dar niciodată data nașterii în sine.
Fiecare apel trimite un e-mail. Apelurile nu sunt deduplicate: dacă apelezi endpointul de două ori, clientul
primește două e-mailuri.
E-mailul nu se trimite când:
- Nu a sosit încă niciun raport de laborator.
- Profilul nu are adresă de e-mail sau are doar o adresă provizorie
@aniva.email. - Profilul a dezactivat e-mailurile tranzacționale. Pentru a le reactiva, setează
transactional_emails_enabledlatruecu Actualizare profil. with_reportsestetrue, iar profilul nu aredate_of_birth. Seteaz-o cu Actualizare profil sau trimite cuwith_reports: false.- Comanda este una dintre comenzile demo de kituri de testare la domiciliu. O comandă demo nu are un client căruia să îi trimiți e-mail.
results_view, plus scope-ul home_kit_orders_view sau home_kit_orders_manage.
Cerere
Parametri de cale
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu pentru care trimiți rezultatele prin e-mail.
Parametri de corp
true atașează rapoartele de laborator ca fișiere PDF protejate cu parolă. false trimite doar notificarea că rezultatele sunt
gata.Răspuns
La succes, API-ul returnează200 OK.
Răspunsuri de eroare
Corpul unei erori conțineerror, un mesaj lizibil, și reason, un cod stabil. Erorile de validare
și lipsa permisiunii results_view nu au reason.
| Status | Motiv | Descriere |
|---|---|---|
400 | — | Eroare de validare — ID invalid, lipsește with_reports sau note are mai mult de 1.000 de caractere. |
403 | access_denied | Interzis — cheia ta API nu are scope-urile necesare sau comanda de kit de testare la domiciliu este în afara contextului tău de acces. |
404 | not_found | Comanda de kit de testare la domiciliu nu a fost găsită. |
409 | demo_order | Comanda este o comandă demo de kit de testare la domiciliu. Nu are un client căruia să îi trimiți e-mail. |
409 | no_reports | Nu a sosit încă niciun raport de laborator. |
409 | no_email | Profilul nu are adresă de e-mail. |
409 | placeholder_email | Profilul are doar o adresă provizorie @aniva.email. Actualizează profilul cu o adresă de e-mail reală. |
409 | unsubscribed | Profilul a dezactivat e-mailurile tranzacționale. Setează mai întâi transactional_emails_enabled la true. |
409 | no_birthdate | with_reports este true, iar profilul nu are date_of_birth, parola PDF-ului. |
413 | reports_too_large | Rapoartele sunt prea mari pentru un singur e-mail. Trimite e-mailul cu with_reports: false. |
422 | report_unprotectable | Un raport nu este PDF sau nu a putut fi protejat cu parolă. Trimite cu with_reports: false. |
500 | — | Eroare internă de server. |
502 | report_unavailable | Un raport de laborator nu a putut fi încărcat. Nu s-a trimis niciun e-mail. |
502 | send_failed | Furnizorul de e-mail a refuzat e-mailul. Nu s-a trimis niciun e-mail. |
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"
}