Varaa verikokeet suoraan omasta sovelluksestasi

Yhdellä API-avaimella saat käyttöösi 45 rajapintaa, varauksista laboratoriotuloksiin

Aniva Partner API varaa verinäytteenoton yli 25 toimipisteessä Saksassa, lisää tutkimuspaketteja kyseiseen varausajankohtaan ja palauttaa kliiniset ja geneettiset tulokset JSON-muodossa. Jokaisessa pyynnössä on oltava yksi otsikkokenttä, ja perus-URL on sama kaikissa ympäristöissä.

Hanki API-avain

Lue ohjeet

Milloin Anivaa tulisi käyttää

Käytä Anivaa, kun asiakkaasi tarvitsee varata verikokeen

Käytä vastaanoton näytteenottopisteitä, kun kyseessä on näytteenotto klinikalla, ja kotinäytteenottosarjan näytteenottopisteitä, kun kyseessä on postitse lähetettävä näytteenottosarja.

Käytä tulosten päätepisteitä kliinisten rivien, geneettisten rivien ja PDF-raportin osalta.

Käytä luettelon päätepisteitä lukeaksesi tiedot Anivan myymistä biomarkkereista, paneeleista ja yksiköistä.

Käytä osoitteessa https://anivahealth.com/api/v1/ lueteltuja polkuja äläkä keksi omia päätepisteitä.

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

const res = await fetch('https://anivahealth.com/api/v1/appointments', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.ANIVA_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    profile_id: profile.id,
    location_id: location.id,
    scheduled_at: '2026-05-15T12:30:00+02:00', // offset required
  }),
});
const appointment = await res.json();

{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "scheduled_at": "2026-05-15T12:30:00+02:00",
  "status": "confirmed",
  "test_method": "practitioner",
  "panels": [],
  "shipments": []
}

Perusprosessi koostuu neljästä pyynnöstä

GET /locations POST /profiles POST /tapaamiset POST /tapaamiset/{id}/vahvista

Tällä hetkellä on dokumentoitu 45 päätepistettä, jotka ovat käytössä

Todentamiseen tarvitaan vain yksi pyynnön otsikko

Jokainen polku alkaa etuliitteellä v1

25+

Verinäytteenotto voidaan suorittaa Saksassa sijaitsevissa toimipisteissä

Neljä pyyntöä muodostavat toimivan integraation

Neljä pyyntöä varauksesta laboratoriotuloksiin

Jokainen pyyntö palauttaa tunnisteen, jota seuraava pyyntö tarvitsee, joten perusintegraatio vaatii neljä pyyntöä ennen kuin voit lisätä paneeleja, muuttaa aikatauluja tai kuljettajia.

Vaihe 01 · GET /locations

Luettelet paikat, joihin avaimellasi voi tehdä varauksia

Vastauksessa ilmoitetaan kunkin osoite, aukioloajat ja aikavyöhyke, joten asiakas näkee vain käytettävissä olevat aikavälejä.

Testit

Vaihe 02 · POST /profiles

Luo asiakkaalle profiili

Profiiliin tarvitaan nimi, sukupuolikoodi, syntymäaika ja profile_group-tunniste, joka voi olla joko UUID tai oma slug-tunniste.

Testit

Vaihe 03 · POST /appointments

Varaat ajan valitsemallesi ajankohdalle

Varauksessa tarvitaan profiilin tunnus, sijainnin tunnus sekä ISO 8601 -muotoinen päivämäärä- ja aikamerkintä, johon on liitetty aikapoikkeama tai Z-päätte.

Testit

Vaihe 04 · POST /appointments/{id}/confirm

Vahvistat arvonnan tuotteen viivakoodilla

Tämä pyyntö käynnistää laboratoriotilauksen ja vahvistaa ajanvarauksen, joten tarkista kaikki tutkimuspaketit ennen lähettämistä.

Testit

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

Ominaisuus

Jokainen resurssiryhmä on yksi REST-kokoelma

Voit tilata verinäytteenoton klinikalta tai kotinäytteenottosarjan postitse. Molemmat toimitetaan samassa muodossa, joten sinun tarvitsee kirjoittaa tulosten lukemiseen tarvittava koodi vain kerran.

Profiilit · 4 päätepistettä

Profiili tarkoittaa henkilöä, jolle testi tehdään

Voit hakea profiilin sähköpostiosoitteen perusteella, luoda sen profiiliryhmääsi ja täydentää demografiset tiedot myöhemmin.

Testit

GET /profiles

PATCH /profiles/{id}

Tapaamiset · 15 päätepistettä

Ottelussa on pelikentät ja arvonta

Viisitoista päätepistettä kattavat varauksen ja kaikki siihen myöhemmin tehdyt muutokset, mukaan lukien paneelit, konttien esikatselut ja vahvistus.

Testit

POST /appointments

GET /appointments/{id}/results

Kotipeliasun tilaukset · 10 päätelaitetta

Kotipeliasutilaukset toimitetaan postitse

Kymmenen päätepistettä pyytää profiilin DIY-pakettia, vaihtaa sen paneelit ja palauttaa saman tulosmuodon.

Testit

Luo sarjatilaus

Saat tulokset

Sijainnit · 2 päätepistettä

Paikat kertovat, missä arvonta järjestetään

Lue paikat, joihin avaimellasi voi tehdä varauksen, ja kysy sitten yhdeltä niistä, milloin varattavat aikavälit alkavat.

Testit

GET /sijainnit

GET /sijainnit/{id}/saatavuus

Asiakirjat · 1 päätepiste

Tulokset ilmenevät kliinisinä ja geneettisinä poikkeavuuksina

Jokaisella tilaustyypillä on oma tuloskutsunsa, ja PDF-raportti on yksi erillinen lataus tiedostotunnuksen mukaan.

Testit

GET /appointments/{id}/results

GET /documents/{id}

Lähetykset · 8 päätepistettä

Kuriiri vie näytteen laboratorioon

Luo kuriiritilaus, johon määrität arkipäivän noutoaikavälin, liitä siihen noutoajat ja seuraa tilauksen tilapäivityksiä.

Testit

POST /lähetykset

Liitä tapaamiset

Luettelot · 4 päätepistettä

Luetteloissa on lueteltu ne biomarkkerit, joita voit tilata

Biomarkkeri-, paneeli- ja yksikköluettelot on sivutettu, ja voit suodattaa biomarkkereita testauspaikan mukaan.

Testit

GET /biomarkkerit

GET /panels

Terveys · 1 päätepiste

Yksi valmius-päätelaitteisto ei vaadi API-avainta

Valmiustarkistus ei vaadi API-avainta, joten käytettävyysvalvontajärjestelmäsi voi kutsua sitä aikataulun mukaisesti.

Testit

Kansalaisten valmiutta koskeva selvitys

Työsi päättyy viivakoodin vahvistukseen

Laboratorioprosessi käynnistyy, kun vahvistat verinäytteenoton

Lähetät meille paketin viivakoodin, ja se on ainoa asia, jota sinulta tarvitsemme. Sen jälkeen hoidamme itse pakkausten, kuljetuksen ja laboratorion järjestelyt, joten sinun tarvitsee olla yhteydessä vain kahteen tahoon, kunnes raportti on valmis.

Täytetty piste kuvaa haluamaasi reittiä.Rengas merkitsee tilaa, jota vielä käsittelet.Oranssit viivat ovat vahvistettu tilaus.

Yksi lukija lukee sekä klinikalla otetun näytteen että kotitestin tulokset

Jokaisella tuloksella on kaksi viitealuetta ja neljä tilaa

Jokaisessa kliinisessä rivissä on laboratorion ilmoittama arvoalue sekä Anivan arvoalue ja sen optimaalinen alue, joten voit esittää molemmat ilman, että sinun tarvitsee ylläpitää omaa hakutaulukkoa.

Rivi luetaan suunnitellusti ennen kuin laboratorio analysoi sen.

Rivi lukee vastaanotetun arvon ja yksikön.

Rivillä näkyy virheilmoitus, kun laboratorio on peruuttanut pyynnön, ja status_reason-kentässä selitetään syy.

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 käyttää kolmea aikamuotoa

Päivämäärille ja kellonajoille on määritettävä aikavyöhyke, muuten pyyntö epäonnistuu

Naivinen datetime-arvo hylätään virhekoodilla 400, mikä on yleisin virhe, jonka useimmat ensimmäiset integraatiot tekevät.

Aikaleimat ilmoitetaan aina UTC-aikana ISO 8601 -standardin mukaisesti, jossa käytetään Z-päätettä.

Syötteissä on oltava nimenomainen aikaero, joten varaus hyväksyy muodon 2026-05-15T12:30:00+02:00.

Lähetystietojen päivityksissä säilytetään logistiikkapalveluntarjoajan ilmoittama poikkeama.

Kalenterikentät koskevat ainoastaan seinäkelloa, kuten syntymäpäivä.

Aniva myöntää ja vaihtaa jokaisen kumppanin avaimen

Jokaisessa pyynnössä tarvitaan kumppanisi API-avain

Todennuksessa käytetään x-api-key-otsikkoa jokaisessa kutsussa, ja jos avain puuttuu tai se on vaihdettu, palautetaan 403-virhe ja lyhyt JSON-virheilmoitus.

Käyttöoikeutesi määräävät, mitkä sijainnit, tapaamiset ja lähetykset näet.

Älä koskaan paljasta API-avaintaasi asiakaspuolen koodissa tai julkisissa arkistoissa.

Julkinen kysely ei vaadi API-avainta

Voit seurata kaikkia palveluja tilasivulta

Tilasivulla näkyy kunkin palvelun nykyinen tila sekä 90 päivän historiatiedot, ja samat tiedot ovat saatavilla JSON-muodossa omaa seurantaasi varten.

Avaa tilasivu

Kumppanitunnukset myöntää tiimimme

Pyydä meiltä kumppanikoodi jo tänään

Kerro meille, millä markkinoilla myyt tuotteitasi ja mitä paneeleja tarvitset, niin lähetämme sinulle avaimen, jolla on tarvittavat käyttöoikeudet.

Hanki API-avain

Lue ohjeet

Voit myös ladata OpenAPI-tiedoston

Tämä sivu on suunnittelumalli. Kaikki sivulla esitetyt päätepisteet ja datapaketit on otettu sivustolta docs.anivahealth.com, ja prosessikaavio on havainnollistava.

Koneellisesti luettavat kopiot asiakirjoista ovat osoitteissa docs.anivahealth.com/llms.txt ja docs.anivahealth.com/llms-full.txt.