Én API-nøgle giver dig 45 endpoints, fra booking til laboratorieresultater
Aniva Partner API booker en blodprøvetagning på over 25 lokationer i Tyskland, tilføjer paneler til den tid og returnerer kliniske og genetiske resultater som JSON. Hver forespørgsel kræver én header, og base-URL'en er den samme i alle miljøer.
Hvornår du skal bruge Aniva
45 endpoints er dokumenteret og live i dag
Autentificering kræver kun én request-header
Hver sti starter med præfikset v1
Tyske lokationer kan udføre blodprøvetagningen
Fire forespørgsler går fra booking til laboratorieresultater
Hver forespørgsel returnerer det ID, den næste har brug for, så en grundlæggende integration er på fire forespørgsler, før du tilføjer paneler, ombookinger eller kurerer.
Du oplister de lokationer, din nøgle kan booke
Svaret giver dig hver adresse, åbningstiderne og tidszonen, så en kunde kun ser tider, der findes.
Du opretter en profil til kunden
En profil skal bruge et navn, en kønskode, en fødselsdato og din profile_group, som accepterer en UUID eller din egen slug.
Du booker tiden på et valgt tidspunkt
Bookingen kræver profil-id, lokations-id og en ISO 8601-tidsangivelse med offset eller Z-suffiks.
Du bekræfter blodprøvetagningen med stregkoden på kittet
Denne anmodning starter laboratorieordren og låser tiden, så ændr alle paneler, før du sender den.
Hver ressourcegruppe er én REST-samling
Du kan bestille en blodprøvetagning på en klinik eller et hjemmetestkit med posten. Begge kommer tilbage i samme format, så du kun behøver at skrive koden, der læser resultater, én gang.
En profil er den person, du tester
Du slår en profil op via e-mail, opretter den under din profilgruppe og opdaterer demografiske data senere.
En tid omfatter panelerne og blodprøvetagningen
Femten endpoints dækker bookingen og enhver senere ændring af den, herunder paneler, forhåndsvisninger af prøvebeholdere og bekræftelsen.
Bestillinger af hjemmetestkit er postversionen
Ti endpoints anmoder om et gør-det-selv-kit til en profil, ændrer dens paneler og returnerer den samme resultatstruktur.
Lokationer viser dig, hvor en blodprøvetagning finder sted
Du læser de lokationer, din nøgle kan booke, og beder derefter en af dem om dens bookbare starttidspunkter.
Resultaterne kommer tilbage som kliniske og genetiske rækker
Hver ordretype har sit eget kald til resultater, og PDF-rapporten er en separat download via fil-ID.
En kurer bringer prøven til laboratoriet
Du opretter en kurerbestilling med et afhentningsvindue på en hverdag, tilknytter derefter tider og følger statusopdateringerne.
Kataloger viser de biomarkører, du kan bestille
Katalogerne over biomarkører, paneler og enheder er opdelt i sider, og du kan filtrere biomarkører efter teststed.
Ét readiness-endpoint kræver ingen API-nøgle
Readiness-proben kræver ingen API-nøgle, så din oppetidsovervågning kan kalde den efter en fast tidsplan.
Laboratorieprocessen starter, når du bekræfter blodprøvetagningen
Du sender os stregkoden på kittet, og det er det sidste, vi har brug for fra dig. Derefter organiserer vi beholderne, kureren og laboratoriet, så din kode kun kalder to endpoints, indtil rapporten er klar.
Hvert resultat har to referenceintervaller og fire statusser
Hver klinisk række indeholder det interval, som laboratoriet har rapporteret, samt Aniva-intervallet med sit optimale vindue, så du kan vise begge dele uden at vedligeholde din egen opslagstabel.
Dato- og tidsangivelser skal have en tidszone, ellers fejler forespørgslen
En naiv datetime afvises med 400, hvilket er den ene fejl, de fleste første integrationer begår.
Hver forespørgsel kræver din partner-API-nøgle
Autentificering bruger x-api-key-headeren ved hvert kald, og en manglende eller roteret nøgle returnerer 403 med en kort JSON-fejl.
Du kan følge alle tjenester på statussiden
Statussiden viser den aktuelle status og 90 dages historik for hver tjeneste, og de samme data er tilgængelige som JSON til din egen overvågning.
Bed os om en partnernøgle i dag
Fortæl os, hvilke markeder du sælger på, og hvilke paneler du har brug for, så sender vi en nøgle med de rette tilladelser.
Denne side er en designskitse. Hvert endpoint og hver payload på siden er hentet fra docs.anivahealth.com, og pipelinediagrammet er illustrativt.
Maskinlæsbare kopier af dokumentationen findes på docs.anivahealth.com/llms.txt og docs.anivahealth.com/llms-full.txt.