Otthoni tesztkészlet-rendelések
Otthoni tesztkészlet-rendelés aktiválása
Jelezd, mikor vette le a páciens a mintáját
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"
}
Jelezd, hogy a páciens levette a mintáját. Ez a
Vérvétel megerősítése otthoni tesztkészletes megfelelője — vonalkód nélkül, mert a készlet
kódja csomagoláskor kerül rá. Csak a mintavétel időbélyegét adod át.
Az időbélyeg klinikailag fontos: ez lesz a mintavétel ideje a laborleleten. A páciens
tényleges mintavételi időpontját küldd el, ne azt a pillanatot, amikor a rendszered feldolgozta.
Ugyanannak az
activated_at értéknek az újraküldése 200 kódot ad vissza az aktivált rendeléssel; egy másik érték 409 kódot ad vissza. Lásd: Idempotencia.
Az aktiválás activated állapotba lépteti a rendelést — ez végleges státusz. Az aktivált rendelés már nem
mondható le, az összetétele és a szállítási címe pedig zárolva van. A rendszer elfogadja az aktiválást, amíg a
rendelés pending vagy dispatched állapotú, feltéve, hogy van lab_code kódja — a páciensnél már lehet
készlet azelőtt is, hogy a nyilvántartásunk feladottként jelölné, a valós mintavételi ideje pedig mindig felülírja a
nyilvántartásunkat. A lab_code nélküli rendelés 409 kódot ad vissza: a kód nélkül a minta nem
párosítható a pácienshez a laboratóriumban.
Az aktiválás egyúttal leadja a laboratóriumi rendelést a készlet paneljére a rendelés lab_code kódja alatt, így
a laboratórium számít a mintára, és az eredmények azonnal hozzárendelhetők, amint megérkeznek. Ez
aszinkron módon, a válasz után történik — egy laboratóriumi probléma soha nem buktatja el a kérésedet. Innentől az
Eredmények lekérése a markereket planned állapotban mutatja, amíg a laboratórium nem jelenti
őket. A home_kit_order.results.updated webhook értesít, amikor változnak.
Ha a minta azelőtt érkezik meg a laboratóriumba, hogy aktiválnád a készletet, az Aniva aktiválja.
Az activated_at értéke a visszaküldött csomag első követési eseményének reggele, vagy ha nincs követés,
annak a napnak a reggele, amikor a minta megérkezett a laboratóriumba. Egy későbbi, eltérő
activated_at értékkel indított hívás ezután 409 kódot ad vissza.
A home_kit_orders_manage scope vagy a szűkebb home_kit_orders_activate scope szükséges hozzá.
Kérés
Útvonalparaméterek
Törzsparaméterek
A páciens mintavételének UTC időpontja (ISO 8601
Z utótaggal, pl.
2026-08-28T07:30:00Z). Nem lehet a jövőben, és nem lehet 30 napnál régebbi.Válasz
Siker esetén az API200 OK választ ad vissza a frissített otthoni tesztkészlet-rendeléssel — a status értéke activated, az
activated_at pedig az általad küldött időbélyeget tartalmazza.
Hibaválaszok
| Státusz | Leírás |
|---|---|
400 | Validációs hiba — hibás formátumú activated_at, jövőbeli vagy 30 napnál régebbi időbélyeg. |
403 | Tiltott — az API-kulcsodnak nincs hozzáférése ehhez a művelethez, vagy az otthoni tesztkészlet-rendelés kívül esik a jogosultsági körödön. |
404 | Az otthoni tesztkészlet-rendelés nem található. |
409 | Ütközés — már aktiválták egy másik mintavételi időponttal, lemondták, vagy még nincs lab_code. |
500 | Belső szerverhiba. |
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"
}