Rezerviraj krvne teste neposredno v svojem izdelku

En ključ API ti omogoča 45 končnih točk, od rezervacije do laboratorijskih rezultatov

Aniva Partner API rezervira odvzem krvi na več kot 25 lokacijah v Nemčiji, temu terminu doda panele ter vrne klinične in genetske rezultate v obliki JSON. Vsak zahtevek potrebuje eno glavo, osnovni URL pa je v vsakem okolju enak.

Kdaj uporabiti Anivo

Uporabi storitev Aniva, ko tvoje stranke potrebujejo rezervacijo krvnega testa
Uporabi končne točke za termin pri odvzemu krvi v kliniki in končne točke za domači testni komplet pri kompletu po pošti.
Za klinične vrstice, genetske vrstice in poročilo PDF uporabi končne točke za rezultate.
Uporabi končne točke kataloga za branje biomarkerjev, panelov in enot, ki jih prodaja Aniva.
Uporabi dokumentirane poti pod https://anivahealth.com/api/v1/ in si ne izmišljuj končnih točk.
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"
  }'
Osnovni potek zajema štiri zahtevke
GET /locations POST /profiles POST /appointments POST /appointments/{id}/confirm
45

Danes je dokumentiranih in aktivnih 45 končnih točk

1

Avtentikacija potrebuje le eno glavo zahtevka

v1

Vsaka pot se začne s predpono v1

25+

Nemške lokacije lahko opravijo odvzem krvi

Štirje zahtevki ustvarijo delujočo integracijo

Štirje zahtevki vodijo od rezervacije do laboratorijskih rezultatov

Vsak zahtevek vrne ID, ki ga potrebuje naslednji, zato osnovna integracija obsega štiri zahtevke, še preden dodaš panele, prestavitve terminov ali kurirje.

Korak 01 · GET /locations

Navedeš lokacije, ki jih lahko tvoj ključ rezervira

Odgovor ti vrne vsak naslov, delovni čas in časovni pas, zato stranka vidi le termine, ki dejansko obstajajo.

Testi
Korak 02 · POST /profiles

Ustvariš profil za stranko

Profil potrebuje ime, kodo spola, datum rojstva in tvoj profile_group, ki sprejme UUID ali tvoj lastni slug.

Testi
Korak 03 · POST /appointments

Termin rezerviraš ob izbrani uri

Rezervacija potrebuje ID profila, ID lokacije ter datum in čas v formatu ISO 8601 z odmikom ali pripono Z.

Testi
Korak 04 · POST /appointments/{id}/confirm

Odvzem krvi potrdiš s črtno kodo kompleta

Ta zahteva sproži laboratorijsko naročilo in zaklene termin, zato spremeni vse panele, preden jo pošlješ.

Testi
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"
  }'
Zmogljivost

Vsaka skupina virov je ena zbirka REST

Naročiš lahko odvzem krvi v ambulanti ali domači testni komplet po pošti. Oba se vrneta v isti obliki, zato kodo za branje rezultatov napišeš le enkrat.

Profili · 4 končne točke

Profil je oseba, ki jo testiraš

Profil poiščeš po e-pošti, ga ustvariš v svoji skupini profilov in pozneje dopolniš demografske podatke.

Testi
GET /profiles
PATCH /profiles/{id}
Termini · 15 končnih točk

Termin vključuje panele in odvzem krvi

Petnajst končnih točk pokriva rezervacijo in vsako poznejšo spremembo, vključno s paneli, predogledi vsebnikov in potrditvijo.

Testi
POST /appointments
GET /appointments/{id}/results
Naročila domačih testnih kompletov · 10 končnih točk

Naročila domačih testnih kompletov so poštna različica

Deset končnih točk zahteva komplet za domačo uporabo za profil, spremeni njegove panele in vrne enako obliko rezultatov.

Testi
Ustvari naročilo kompleta
Prejmi rezultate
Lokacije · 2 končni točki

Lokacije ti povedo, kje poteka odvzem krvi

Prebereš lokacije, ki jih tvoj ključ lahko rezervira, nato pa pri eni od njih zaprosiš za začetke razpoložljivih terminov.

Testi
GET /locations
GET /locations/{id}/availability
Dokumenti · 1 končna točka

Rezultati prispejo kot klinične in genetske vrstice

Vsaka vrsta naročila ima svoj klic za rezultate, poročilo PDF pa je ločen prenos po ID-ju datoteke.

Testi
GET /appointments/{id}/results
GET /documents/{id}
Pošiljke · 8 končnih točk

Kurir odnese vzorec v laboratorij

Ustvariš kurirsko naročilo s časovnim oknom prevzema med tednom, nato dodaš termine in spremljaš posodobitve statusa.

Testi
POST /shipments
Pripni termine
Katalogi · 4 končne točke

Katalogi navajajo biomarkerje, ki jih lahko naročiš

Katalogi biomarkerjev, panelov in enot so razdeljeni na strani, biomarkerje pa lahko filtriraš po lokaciji testiranja.

Testi
GET /biomarkers
GET /panels
Zdravje · 1 končna točka

Ena končna točka pripravljenosti ne potrebuje ključa API

Preverjanje pripravljenosti ne potrebuje ključa API, zato ga tvoj sistem za spremljanje delovanja lahko kliče po urniku.

Testi
Javno preverjanje pripravljenosti
Tvoje delo se konča pri potrditvi črtne kode

Laboratorijski postopek se začne, ko potrdiš odvzem krvi

Pošlješ nam črtno kodo kompleta in to je zadnja stvar, ki jo potrebujemo od tebe. Nato uredimo posodice, kurirja in laboratorij, tako da tvoja koda pokliče le dve končni točki, dokler ni izvid pripravljen.

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
Polna pika je pot, ki jo želiš.Krogec je stanje, ki ga še urejaš.Oranžne črte so potrjeno naročilo.
En razčlenjevalnik prebere odvzem krvi v kliniki in domači testni komplet

Vsak rezultat ima dve referenčni območji in štiri statuse

Vsaka klinična vrstica vsebuje območje, ki ga je sporočil laboratorij, in območje Aniva z optimalnim razponom, tako da lahko prikažeš obe brez vzdrževanja lastne referenčne tabele.

V vrstici piše načrtovano, preden jo laboratorij analizira.
Vrstica prikaže prejeto, ko se vrneta vrednost in enota.
V vrstici piše fault, ko je laboratorij preklical naročilo, status_reason pa to pojasnjuje.
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 uporablja tri oblike zapisa časa

Datumi in časi potrebujejo časovni pas, sicer zahteva ne uspe

Naiven zapis datuma in časa se zavrne s 400, kar je glavna napaka, ki jo naredi večina prvih integracij.

Časovni žigi se vedno vrnejo v UTC, v formatu ISO 8601 s pripono Z.
Vnosi morajo vključevati izrecen časovni odmik, zato rezervacija sprejme 2026-05-15T12:30:00+02:00.
Posodobitve pošiljke ohranijo časovni odmik, ki ga je sporočil logistični ponudnik.
Koledarska polja uporabljajo zgolj lokalni čas brez časovnega pasu, na primer datum rojstva.
Aniva izdaja in menja vsak partnerski ključ

Vsak zahtevek potrebuje tvoj partnerski ključ API

Avtentikacija pri vsakem klicu uporablja glavo x-api-key, manjkajoči ali zamenjani ključ pa vrne 403 s kratko napako JSON.

Tvoj ključ določa, katere lokacije, termine in pošiljke lahko vidiš.
Svojega ključa API nikoli ne razkrivaj v kodi na strani odjemalca ali v javnih repozitorijih.
Javno preverjanje ne potrebuje ključa API

Vsako storitev lahko spremljaš na statusni strani

Stran s stanjem prikazuje trenutno stanje in 90 dni zgodovine za vsako storitev, isti podatki pa so na voljo kot JSON za tvoj lastni nadzor.

Partnerske ključe izdaja naša ekipa

Zaprosi nas za partnerski ključ še danes

Povej nam, na katerih trgih prodajaš in katere panele potrebuješ, in poslali ti bomo ključ s pravimi dovoljenji.

Preneseš lahko tudi datoteko OpenAPI

Ta stran je oblikovni osnutek. Vsaka končna točka in podatkovna vsebina na njej je povzeta iz docs.anivahealth.com, diagram poteka pa je ilustrativen.

Strojno berljivi kopiji dokumentacije sta na docs.anivahealth.com/llms.txt in docs.anivahealth.com/llms-full.txt.