Otthoni tesztkészlet-rendelések
Eredmények elküldése e-mailben
Értesítsd e-mailben az ügyfelet, hogy elkészültek az otthoni tesztkészlete laboreredményei
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"
}
Küldj az ügyfélnek egy e-mailt arról, hogy elkészültek a laboreredményei. Az e-mail az otthoni
tesztkészlet-rendelés profiljának
email címére megy.
Az e-mail általános partnerarculatot használ: a profil elsődleges profilcsoportjának nevét és
logóját. A nyelve a profil language értéke, alapértelmezés szerint angol.
Állítsd a with_reports mezőt true értékre a tesztkészlet laboratóriumi leleteinek csatolásához. Az e-mail
minden olyan leletet csatol, amelyet az ügyfél az alkalmazásban lát. Állítsd false értékre,
ha csak az értesítést szeretnéd elküldeni. Adj hozzá note mezőt, ha személyes megjegyzést szeretnél megjeleníteni az e-mailben, legfeljebb 1 000 karakterben.
Minden csatolt lelet AES-256 titkosítású PDF. A jelszó a profil date_of_birth értéke
8 számjegyként, DDMMYYYY formátumban, pontok nélkül: egy 1985. február 1-jén született ügyfél
ezt írja be: 01021985. Az e-mail közli az ügyféllel ezt a formátumot, de magát a születési dátumot soha.
Minden hívás egy e-mailt küld. A hívások nincsenek deduplikálva: ha kétszer hívod meg a végpontot, az ügyfél
két e-mailt kap.
Nem küldünk e-mailt, ha:
- Még nem érkezett laboratóriumi lelet.
- A profilnak nincs e-mail-címe, vagy csak egy helyőrző
@aniva.emailcíme van. - A profil kikapcsolta a tranzakciós e-maileket. Az újbóli bekapcsolásukhoz állítsd a
transactional_emails_enabledmezőttrueértékre a Profil frissítése végponttal. - A
with_reportsértéketrue, és a profilnak nincsdate_of_birthmezője. Állítsd be a Profil frissítése végponttal, vagy küldd elwith_reports: falseértékkel. - A rendelés egy demó otthoni tesztkészlet-rendelés. A demó rendeléshez nem tartozik ügyfél, akinek e-mailt lehetne küldeni.
results_view jogosultsági kör, valamint a home_kit_orders_view vagy a home_kit_orders_manage jogosultsági kör szükséges hozzá.
Kérés
Útvonalparaméterek
Annak az otthoni tesztkészlet-rendelésnek az egyedi azonosítója (UUID), amelynek az eredményeit e-mailben küldöd el.
Törzsparaméterek
A
true érték jelszóval védett PDF-fájlként csatolja a laborleleteket. A false érték csak azt az értesítést küldi el, hogy az eredmények
elkészültek.Személyes megjegyzés, amelyet az e-mail az értesítés alatt jelenít meg. Legfeljebb 1 000 karakter.
Válasz
Siker esetén az API200 OK választ ad vissza.
Hibaválaszok
A hibatörzs tartalmazza azerror mezőt, amely ember által olvasható üzenet, valamint a reason mezőt, amely stabil kód. Validációs hibáknál
és hiányzó results_view scope esetén nincs reason.
| Állapot | Ok | Leírás |
|---|---|---|
400 | — | Érvényesítési hiba — érvénytelen azonosító, hiányzó with_reports, vagy 1 000 karakternél hosszabb note. |
403 | access_denied | Tiltott — az API-kulcsod nem rendelkezik a szükséges jogosultsági körökkel, vagy az otthoni tesztkészlet-rendelés kívül esik a hozzáférési körödön. |
404 | not_found | Az otthoni tesztkészlet-rendelés nem található. |
409 | demo_order | A rendelés demó otthoni tesztkészlet-rendelés. Nem tartozik hozzá ügyfél, akinek e-mailt lehetne küldeni. |
409 | no_reports | Még nem érkezett laboratóriumi lelet. |
409 | no_email | A profilnak nincs e-mail-címe. |
409 | placeholder_email | A profilnak csak egy helyőrző @aniva.email címe van. Frissítsd a profilt egy valós e-mail-címmel. |
409 | unsubscribed | A profil kikapcsolta a tranzakciós e-maileket. Előbb állítsd a transactional_emails_enabled mezőt true értékre. |
409 | no_birthdate | A with_reports értéke true, és a profilnak nincs date_of_birth mezője, amely a PDF jelszava. |
413 | reports_too_large | A leletek túl nagyok egyetlen e-mailhez. Küldd el az e-mailt with_reports: false értékkel. |
422 | report_unprotectable | Az egyik lelet nem PDF, vagy nem sikerült jelszóval védeni. Küldd el with_reports: false értékkel. |
500 | — | Belső szerverhiba. |
502 | report_unavailable | Egy laboratóriumi leletet nem sikerült betölteni. Nem küldtünk e-mailt. |
502 | send_failed | Az e-mail-szolgáltató elutasította az e-mailt. Nem küldtünk e-mailt. |
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"
}