Broneeri vereanalüüse otse oma toote seest

Üks API-võti annab sulle 45 otspunkti alates broneerimisest kuni laboritulemusteni

Aniva Partner API broneerib vereproovi võtmise enam kui 25 asukohas üle Saksamaa, lisab sellele ajale paneelid ning tagastab kliinilised ja geneetilised tulemused JSON-vormingus. Iga päring vajab ühte päist ja baas-URL on igas keskkonnas sama.

Millal kasutada Anivat

Kasuta Anivat, kui sinu klientidel on vaja vereanalüüs broneerida
Kasuta kliinikus vereproovi võtmiseks aja otspunkte ja postiga saadetava komplekti jaoks koduse testikomplekti otspunkte.
Kasuta tulemuste lõpp-punkte kliiniliste ridade, geneetiliste ridade ja PDF-raporti jaoks.
Kasuta kataloogi otspunkte, et lugeda biomarkereid, paneele ja ühikuid, mida Aniva müüb.
Kasuta aadressi https://anivahealth.com/api/v1/ all dokumenteeritud teid ja ära mõtle välja otspunkte.
POST /api/v1/appointments
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T12:30:00+02:00"
  }'
Põhitöövoog koosneb neljast päringust
GET /locations POST /profiles POST /appointments POST /appointments/{id}/confirm
45

45 otspunkti on dokumenteeritud ja täna töös

1

Autentimiseks on vaja ainult ühte päringupäist

v1

Iga tee algab eesliitega v1

25+

Saksamaa asukohtades saab vereproovi võtta

Neli päringut loovad töötava integratsiooni

Broneeringust laboritulemusteni viib neli päringut

Iga päring tagastab ID, mida järgmine vajab, nii et põhiintegratsioon koosneb neljast päringust, enne kui lisad paneele, ümberbroneerimisi või kullereid.

Samm 01 · GET /locations

Sa loetled asukohad, kuhu sinu võti saab broneerida

Vastus annab sulle iga aadressi, lahtiolekuajad ja ajavööndi, nii et klient näeb ainult olemasolevaid aegu.

Analüüsid
Samm 02 · POST /profiles

Lood kliendile profiili

Profiil vajab nime, sookoodi, sünnikuupäeva ja sinu profile_group väärtust, kuhu sobib UUID või sinu enda slug.

Analüüsid
Samm 03 · POST /appointments

Broneerid aja valitud kellaajaks

Broneerimiseks on vaja profiili ID-d, asukoha ID-d ning ISO 8601 kuupäeva ja kellaaega koos ajavööndi nihke või Z-sufiksiga.

Analüüsid
Samm 04 · POST /appointments/{id}/confirm

Kinnitad vereproovi võtmise komplekti triipkoodiga

See päring käivitab laboritellimuse ja lukustab aja, nii et muuda kõik paneelid enne selle saatmist.

Analüüsid
POST /api/v1/appointments
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T12:30:00+02:00"
  }'
Võimekus

Iga ressursirühm on üks REST-kollektsioon

Saad tellida vereproovi võtmise kliinikus või koduse testikomplekti postiga. Mõlemad tulevad tagasi samas vormingus, nii et pead tulemusi lugeva koodi kirjutama vaid korra.

Profiilid · 4 otspunkti

Profiil on inimene, keda sa testid

Otsid profiili üles e-posti järgi, lood selle oma profiiligruppi ja täiendad demograafilisi andmeid hiljem.

Analüüsid
GET /profiles
PATCH /profiles/{id}
Ajad · 15 lõpp-punkti

Aeg sisaldab paneele ja vereproovi võtmist

Viisteist lõpp-punkti katavad broneeringu ja iga selle hilisema muudatuse, sealhulgas paneelid, proovinõude eelvaated ja kinnituse.

Analüüsid
POST /appointments
GET /appointments/{id}/results
Koduste testikomplektide tellimused · 10 lõpp-punkti

Koduste testikomplektide tellimused on postiversioon

Kümme lõpp-punkti tellivad profiilile kodutesti komplekti, muudavad selle paneele ja tagastavad sama kujuga tulemused.

Analüüsid
Loo komplekti tellimus
Saa tulemused
Asukohad · 2 otspunkti

Asukohad näitavad, kus vereproovi võtmine toimub

Loed asukohad, mida sinu võtmega saab broneerida, ja küsid seejärel ühelt neist selle broneeritavate aegade algusaegu.

Analüüsid
GET /locations
GET /locations/{id}/availability
Dokumendid · 1 otspunkt

Tulemused saabuvad kliiniliste ja geneetiliste ridadena

Igal tellimusetüübil on oma tulemuste päring ja PDF-aruanne on eraldi allalaadimine faili ID järgi.

Analüüsid
GET /appointments/{id}/results
GET /documents/{id}
Saadetised · 8 otspunkti

Kuller viib proovi laborisse

Lood kulleritellimuse tööpäevase pealekorje ajavahemikuga, seod sellega ajad ja jälgid oleku uuendusi.

Analüüsid
POST /shipments
Seo ajad
Kataloogid · 4 otspunkti

Kataloogides on loetletud biomarkerid, mida saad tellida

Biomarkerite, paneelide ja ühikute kataloogid on lehekülgedeks jagatud ning saad biomarkereid analüüsi asukoha järgi filtreerida.

Analüüsid
GET /biomarkers
GET /panels
Tervis · 1 otspunkt

Üks valmisoleku lõpp-punkt ei vaja API-võtit

Valmisolekukontroll ei vaja API-võtit, nii et sinu tööaja monitor saab seda ajakava järgi välja kutsuda.

Analüüsid
Avalik valmisolekukontroll
Sinu töö lõpeb triipkoodi kinnitamisega

Laboriprotsess algab siis, kui kinnitad vereproovi võtmise

Saadad meile komplekti vöötkoodi ja see on viimane asi, mida sinult vajame. Seejärel korraldame anumad, kulleri ja labori, nii et sinu kood kutsub aruande valmimiseni välja vaid kaks lõpp-punkti.

The Aniva lab pipeline from confirmation to results Confirming the draw is followed by container selection, courier collection and laboratory analysis, and each biomarker row then reads as planned, received or fault. POST /appointments/{id}/confirmYou confirm the draw GET /appointments/{id}/previewContainers are known POST /shipmentsA courier collects it Aniva laboratory networkThe laboratory analyses planned received fault GET /appointments/{id}/results
Täidetud täpp on soovitud tee.Ring on olek, mida sa veel haldad.Oranžid jooned on kinnitatud tellimus.
Üks parser loeb kliinikus võetud vereproovi ja kodust testikomplekti

Igal tulemusel on kaks referentsvahemikku ja neli staatust

Igal kliinilisel real on labori esitatud vahemik ja Aniva vahemik koos optimaalse alaga, nii et saad kuvada mõlemat ilma oma vastavustabelit pidamata.

Rida näitab enne labori analüüsi olekut planeeritud.
Rida kuvab olekut vastu võetud niipea, kui väärtus ja ühik on saabunud.
Real kuvatakse fault, kui labor tellimuse tühistas, ja status_reason selgitab seda.
GET /api/v1/appointments/{id}/results
{
  "status": "in_progress",
  "clinical_results": [{
    "status": "received",
    "biomarker_name": "Vitamin D",
    "value": 38.5, "unit": "ng/mL",
    "reference_range_lab": { "normal_min": 30, "normal_max": 100 },
    "reference_range_aniva": { "optimal_min": 40, "optimal_max": 60 },
    "tested_at": "2026-04-05"
  }],
  "documents": [{ "file_name": "lab-report-2026-04-05.pdf" }]
}
API kasutab kolme ajavormingut

Kuupäevad ja kellaajad vajavad ajavööndit, muidu päring ebaõnnestub

Ajavööndita kuupäev ja kellaaeg lükatakse koodiga 400 tagasi, mis on peamine viga esimestes integratsioonides.

Ajatemplid tagastatakse alati UTC-s, kasutades ISO 8601 vormingut koos Z-järelliitega.
Sisendid peavad sisaldama selget ajavööndi nihet, seega võtab broneering vastu 2026-05-15T12:30:00+02:00.
Saadetise uuendused säilitavad logistikateenuse pakkuja edastatud nihke.
Kalendriväljad on ainult kohaliku aja järgi, näiteks sünnikuupäev.
Aniva väljastab ja roteerib iga partnerivõtme

Iga päring vajab sinu partneri API-võtit

Autentimiseks kasutatakse igal päringul päist x-api-key ning puuduv või vahetatud võti tagastab koodi 403 koos lühikese JSON-veateatega.

Sinu võti määrab, milliseid asukohti, aegu ja saadetisi sa näed.
Ära kunagi avalda oma API-võtit kliendipoolses koodis ega avalikes repositooriumides.
Avalik kontrollpäring ei vaja API-võtit

Saad iga teenust jälgida olekulehel

Olekuleht näitab iga teenuse hetkeseisu ja 90 päeva ajalugu ning samad andmed on sinu enda monitooringu jaoks saadaval JSON-vormingus.

Partnerivõtmed väljastab meie meeskond

Küsi meilt partnerivõtit juba täna

Ütle meile, millistel turgudel sa müüd ja milliseid paneele vajad, ning me saadame vajalike õigustega võtme.

Saad alla laadida ka OpenAPI-faili

See leht on kujunduskavand. Iga sellel olev lõpp-punkt ja andmepakett pärineb aadressilt docs.anivahealth.com ning andmevoo skeem on illustratiivne.

Dokumentatsiooni masinloetavad koopiad asuvad aadressidel docs.anivahealth.com/llms.txt ja docs.anivahealth.com/llms-full.txt.