Evde test kiti siparişleri
Evde test kiti siparişini etkinleştir
Hastanın örneğini ne zaman aldığını bildir
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
activate
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"delivery_address": {
"name": "Maria Schmidt",
"company_name": "c/o Weber",
"address_line_2": null,
"street": "Friedrichstraße",
"house_number": "123",
"postal_code": "10117",
"city": "Berlin",
"country_code": "DE",
"phone": "+4930123456789",
"email": "maria.schmidt@example.com"
},
"created_at": "2026-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"profile": {
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
Hastanın numunesini aldığını bildir. Bu, Kan almayı onayla
uç noktasının evde test kiti karşılığıdır — barkod olmadan, çünkü kitin kodu kit paketlenirken
eklenir. Yalnızca numune alma zaman damgasını gönderirsin.
Zaman damgası klinik açıdan önemlidir: laboratuvar raporunda yer alacak numune alma zamanıdır.
Sisteminin bunu işlediği anı değil, hastanın numuneyi gerçekten aldığı anı gönder.
Aynı
activated_at değerini tekrar göndermek etkinleştirilen siparişle birlikte 200 döndürür; farklı bir değer göndermek 409 döndürür. Bkz. İdempotans.
Etkinleştirme, siparişi nihai bir durum olan activated durumuna geçirir. Etkinleştirilmiş bir
sipariş artık iptal edilemez; içeriği ve teslimat adresi kilitlenir. Siparişin bir lab_code
değeri olduğu sürece pending veya dispatched durumundayken etkinleştirme kabul edilir — kayıtlarımız
gönderildi olarak güncellenmeden önce hasta kiti elinde tutuyor olabilir ve gerçek numune alma zamanı
her zaman kayıtlarımızın önündedir. lab_code içermeyen bir sipariş 409 döndürür: kod olmadan
numune laboratuvarda hastayla eşleştirilemez.
Etkinleştirme, kitin paneli için siparişin lab_code değeri altında laboratuvar siparişini de
oluşturur; böylece numune laboratuvarda beklenir ve sonuçlar bildirildiği anda eklenebilir. Bu
işlem yanıttan sonra eşzamansız olarak gerçekleşir — bir laboratuvar sorunu isteğini hiçbir zaman
başarısız kılmaz. Bu noktadan itibaren Sonuçları al, laboratuvar
bildirene kadar belirteçleri planned olarak gösterir. Değiştiklerinde home_kit_order.results.updated
webhook’u sana haber verir.
Numune, sen kiti etkinleştirmeden önce laboratuvara ulaşırsa kiti Aniva etkinleştirir.
activated_at, iade paketinin ilk takip olayının sabahı veya takip bilgisi yoksa numunenin
laboratuvara ulaştığı sabahtır. Daha sonra farklı bir activated_at ile yapılan bir çağrı 409
döndürür.
home_kit_orders_manage kapsamını veya daha dar olan home_kit_orders_activate kapsamını gerektirir.
İstek
Yol parametreleri
Gövde parametreleri
Hastanın numuneyi aldığı UTC zamanı (
Z son ekiyle ISO 8601, örn.
2026-08-28T07:30:00Z). Gelecekte veya 30 günden daha geçmişte olmamalıdır.Yanıt
Başarılı olduğunda API, güncellenmiş evde test kiti siparişiyle200 OK döndürür — status activated olur ve
activated_at gönderdiğin zaman damgasını taşır.
Hata yanıtları
| Durum | Açıklama |
|---|---|
400 | Doğrulama hatası — hatalı biçimlendirilmiş activated_at, gelecekte bir zaman damgası veya 30 günden eski bir zaman damgası. |
403 | Yasak — API anahtarının bu işleme erişimi yok veya evde test kiti siparişi izin kapsamının dışında. |
404 | Evde test kiti siparişi bulunamadı. |
409 | Çakışma — farklı bir örnek alma zamanıyla zaten etkinleştirilmiş, iptal edilmiş veya henüz lab_code yok. |
500 | İç sunucu hatası. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"delivery_address": {
"name": "Maria Schmidt",
"company_name": "c/o Weber",
"address_line_2": null,
"street": "Friedrichstraße",
"house_number": "123",
"postal_code": "10117",
"city": "Berlin",
"country_code": "DE",
"phone": "+4930123456789",
"email": "maria.schmidt@example.com"
},
"created_at": "2026-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"profile": {
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"delivery_address": {
"name": "Maria Schmidt",
"company_name": "c/o Weber",
"address_line_2": null,
"street": "Friedrichstraße",
"house_number": "123",
"postal_code": "10117",
"city": "Berlin",
"country_code": "DE",
"phone": "+4930123456789",
"email": "maria.schmidt@example.com"
},
"created_at": "2026-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"profile": {
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}