Objednávky domácích testovacích sad
Odeslat výsledky e-mailem
Poslat zákazníkovi e-mail, že jsou laboratorní výsledky z jeho domácí testovací sady připravené
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"
}
Pošli zákazníkovi jeden e-mail s informací, že jsou jeho laboratorní výsledky připraveny. E-mail
se odešle na
email profilu objednávky domácí testovací sady.
E-mail používá obecný partnerský branding: název a logo primární profilové
skupiny profilu. Je v jazyce language profilu, výchozí je angličtina.
Nastav with_reports na true, pokud chceš připojit laboratorní zprávy ze sady. E-mail
obsahuje všechny zprávy, které zákazník vidí v aplikaci. Nastav ho na false, pokud chceš
poslat jen upozornění. Přidej note, aby se v e-mailu zobrazila osobní poznámka, maximálně 1 000 znaků.
Každá přiložená zpráva je PDF zašifrované pomocí AES-256. Heslem je date_of_birth z
profilu jako 8 číslic ve formátu DDMMYYYY bez teček: zákazník narozený 1. února 1985 zadá
01021985. E-mail zákazníkovi tento formát sdělí, ale nikdy samotné datum narození.
Každé volání odešle jeden e-mail. Volání se nededuplikují: když endpoint zavoláš dvakrát, zákazník
dostane dva e-maily.
E-mail se neodešle, když:
- Zatím nedorazila žádná laboratorní zpráva.
- Profil nemá e-mailovou adresu, nebo má jen zástupnou adresu
@aniva.email. - Profil má vypnuté transakční e-maily. Pokud je chceš znovu zapnout, nastav
transactional_emails_enablednatruepřes Upravit profil. with_reportsjetruea profil nemádate_of_birth. Nastav ho přes Upravit profil, nebo pošli požadavek swith_reports: false.- Objednávka je jedna z demo objednávek domácí testovací sady. Demo objednávka nemá zákazníka, kterému by se dal poslat e-mail.
results_view a k tomu rozsah home_kit_orders_view nebo home_kit_orders_manage.
Požadavek
Parametry cesty
Jedinečný identifikátor (UUID) objednávky domácí testovací sady, jejíž výsledky chceš poslat e-mailem.
Parametry těla
true přiloží laboratorní zprávy jako PDF soubory chráněné heslem. false odešle jen oznámení, že jsou výsledky
připravené.Odpověď
Při úspěchu vrátí API200 OK.
Chybové odpovědi
Tělo chyby obsahujeerror, srozumitelnou zprávu, a reason, stabilní kód. Chyby validace
a chybějící scope results_view pole reason nemají.
| Stav | Důvod | Popis |
|---|---|---|
400 | — | Chyba validace — neplatné ID, chybí with_reports, nebo je note delší než 1 000 znaků. |
403 | access_denied | Zakázáno — tvůj API klíč nemá potřebné rozsahy, nebo je objednávka domácí testovací sady mimo tvůj přístupový kontext. |
404 | not_found | Objednávka domácí testovací sady nebyla nalezena. |
409 | demo_order | Objednávka je demo objednávkou domácí testovací sady. Nemá zákazníka, kterému by se dal poslat e-mail. |
409 | no_reports | Zatím nedorazila žádná laboratorní zpráva. |
409 | no_email | Profil nemá e-mailovou adresu. |
409 | placeholder_email | Profil má jen zástupnou adresu @aniva.email. Doplň do profilu skutečný e-mail. |
409 | unsubscribed | Profil má vypnuté transakční e-maily. Nejdřív nastav transactional_emails_enabled na true. |
409 | no_birthdate | with_reports je true a profil nemá date_of_birth, které slouží jako heslo k PDF. |
413 | reports_too_large | Zprávy jsou pro jeden e-mail příliš velké. Pošli e-mail s with_reports: false. |
422 | report_unprotectable | Zpráva není ve formátu PDF, nebo ji nešlo zaheslovat. Pošli e-mail s with_reports: false. |
500 | — | Interní chyba serveru. |
502 | report_unavailable | Laboratorní zprávu se nepodařilo načíst. E-mail nebyl odeslán. |
502 | send_failed | Poskytovatel e-mailu zprávu odmítl. E-mail nebyl odeslán. |
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"
}