Evde test kiti siparişleri
Sonuçları e-postayla gönder
Müşteriye evde test kitinin laboratuvar sonuçlarının hazır olduğunu e-postayla bildir
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"
}
Müşteriye laboratuvar sonuçlarının hazır olduğunu bildiren bir e-posta gönder. E-posta, evde test
kiti siparişinin profilindeki
email adresine gider.
E-posta genel iş ortağı markalamasını kullanır: profilin birincil profil grubunun adı ve
logosu. Profilin language dilindedir, varsayılan olarak İngilizcedir.
Kitin laboratuvar raporlarını eklemek için with_reports alanını true olarak ayarla. E-postaya
müşterinin uygulamada görebildiği her rapor eklenir. Yalnızca bildirimi göndermek için false
olarak ayarla. E-postada en fazla 1.000 karakterlik kişisel bir not göstermek için note ekle.
Eklenen her rapor, AES-256 ile şifrelenmiş bir PDF’dir. Şifre, profilin date_of_birth değerinin
noktasız 8 haneli DDMMYYYY biçimidir: 1 Şubat 1985 doğumlu bir müşteri
01021985 yazar. E-posta müşteriye bu biçimi söyler ama doğum tarihinin kendisini asla yazmaz.
Her çağrı bir e-posta gönderir. Çağrılar tekilleştirilmez: uç noktayı iki kez çağırırsan müşteri
iki e-posta alır.
E-posta şu durumlarda gönderilmez:
- Henüz laboratuvar raporu gelmedi.
- Profilde e-posta adresi yok ya da yalnızca yer tutucu bir
@aniva.emailadresi var. - Profil işlemsel e-postaları kapattı. Bunları yeniden açmak için
Profili güncelle ile
transactional_emails_enabledalanınıtrueolarak ayarla. with_reportsdeğeritrueve profildedate_of_birthyok. Bunu Profili güncelle ile ayarla veyawith_reports: falseile gönder.- Sipariş, demo evde test kiti siparişlerinden biri. Demo siparişin e-posta gönderilecek müşterisi yok.
results_view kapsamı ile birlikte home_kit_orders_view veya home_kit_orders_manage kapsamını gerektirir.
İstek
Yol parametreleri
Sonuçları e-posta ile gönderilecek evde test kiti siparişinin benzersiz kimliği (UUID).
Gövde parametreleri
true laboratuvar raporlarını şifre korumalı PDF dosyaları olarak ekler. false yalnızca sonuçların hazır olduğuna dair
bildirimi gönderir.Yanıt
Başarılı olduğunda API200 OK döndürür.
Hata yanıtları
Hata gövdesinde okunabilir bir mesaj olanerror ve sabit bir kod olan reason bulunur. Doğrulama hataları
ve eksik results_view kapsamı için reason bulunmaz.
| Durum | Neden | Açıklama |
|---|---|---|
400 | — | Doğrulama hatası — geçersiz ID, eksik with_reports veya 1.000 karakterden uzun note. |
403 | access_denied | Erişim engellendi — API anahtarında gerekli kapsamlar yok veya evde test kiti siparişi erişim bağlamının dışında. |
404 | not_found | Evde test kiti siparişi bulunamadı. |
409 | demo_order | Sipariş bir demo evde test kiti siparişi. E-posta gönderilecek müşterisi yok. |
409 | no_reports | Henüz laboratuvar raporu gelmedi. |
409 | no_email | Profilde e-posta adresi yok. |
409 | placeholder_email | Profilde yalnızca yer tutucu bir @aniva.email adresi var. Profili gerçek bir e-posta ile güncelle. |
409 | unsubscribed | Profil işlemsel e-postaları kapattı. Önce transactional_emails_enabled alanını true olarak ayarla. |
409 | no_birthdate | with_reports değeri true ve profilde PDF parolası olan date_of_birth yok. |
413 | reports_too_large | Raporlar tek bir e-posta için çok büyük. E-postayı with_reports: false ile gönder. |
422 | report_unprotectable | Raporlardan biri PDF değil veya parola ile korunamadı. with_reports: false ile gönder. |
500 | — | Dahili sunucu hatası. |
502 | report_unavailable | Bir laboratuvar raporu yüklenemedi. E-posta gönderilmedi. |
502 | send_failed | E-posta sağlayıcısı e-postayı reddetti. E-posta gönderilmedi. |
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"
}