En API-nyckel ger dig 45 ändpunkter, från bokning till labbresultat
Aniva Partner API bokar en blodprovstagning på över 25 platser i Tyskland, lägger till paneler till den bokningen och returnerar kliniska och genetiska resultat som JSON. Varje anrop kräver en header och bas-URL:en är densamma i alla miljöer.
När du ska använda Aniva
45 endpoints är dokumenterade och aktiva idag
Autentisering kräver bara en request header
Varje sökväg börjar med prefixet v1
Tyska platser kan utföra blodprovstagningen
Fyra anrop går från bokning till labbresultat
Varje anrop returnerar det ID som nästa anrop behöver, så en grundläggande integration består av fyra anrop innan du lägger till paneler, ombokningar eller bud.
Du listar platserna som din nyckel kan boka
Svaret ger dig varje adress, öppettiderna och tidszonen, så att kunden bara ser tider som faktiskt finns.
Du skapar en profil för kunden
En profil behöver ett namn, en könskod, ett födelsedatum och din profile_group, som accepterar ett UUID eller din egen slug.
Du gör bokningen på en vald tid
Bokningen behöver profil-ID, plats-ID och datum och tid i ISO 8601-format med tidsförskjutning eller Z-suffix.
Du bekräftar blodprovstagningen med streckkoden på kitet
Den här begäran startar beställningen till labbet och låser bokningen, så ändra alla paneler innan du skickar den.
Varje resursgrupp är en REST-samling
Du kan beställa en blodprovstagning på en klinik eller ett hemtestkit med posten. Båda kommer tillbaka i samma format, så du skriver bara koden som läser resultat en gång.
En profil är personen du testar
Du söker upp en profil via e-post, skapar den under din profilgrupp och uppdaterar demografiuppgifter senare.
En bokning innehåller panelerna och blodprovstagningen
Femton endpoints täcker bokningen och varje senare ändring av den, inklusive paneler, förhandsgranskningar av provbehållare och bekräftelsen.
Beställningar av hemtestkit är postversionen
Tio endpoints begär ett hemtestkit för en profil, ändrar dess paneler och returnerar samma resultatstruktur.
Platser visar var en blodprovstagning sker
Du läser in de platser din nyckel kan boka och ber sedan en av dem om dess bokningsbara starttider.
Resultaten kommer tillbaka som kliniska och genetiska rader
Varje ordertyp har ett eget resultatanrop, och PDF-rapporten är en separat nedladdning via fil-ID.
En kurir tar provet till laboratoriet
Du skapar en budbeställning med ett upphämtningsfönster på en vardag, kopplar bokningar till den och följer dess statusuppdateringar.
Kataloger listar de biomarkörer du kan beställa
Katalogerna för biomarkörer, paneler och enheter är paginerade, och du kan filtrera biomarkörer efter testplats.
En readiness-endpoint behöver ingen API-nyckel
Readiness-proben behöver ingen API-nyckel, så din drifttidsövervakning kan anropa den enligt schema.
Labbprocessen startar när du bekräftar blodprovstagningen
Du skickar kitets streckkod till oss, och det är det sista vi behöver från dig. Sedan ordnar vi behållarna, budet och laboratoriet, så din kod anropar bara två slutpunkter tills rapporten är klar.
Varje resultat har två referensintervall och fyra statusar
Varje klinisk rad innehåller intervallet som laboratoriet rapporterat och Anivas intervall med dess optimala spann, så att du kan visa båda utan att hålla en egen uppslagstabell.
Datum och tid kräver en tidszon, annars misslyckas förfrågan
En naiv datetime avvisas med 400, vilket är det enskilda misstag de flesta gör vid första integrationen.
Varje anrop kräver din partner-API-nyckel
Autentisering använder headern x-api-key vid varje anrop, och en saknad eller roterad nyckel returnerar 403 med ett kort JSON-fel.
Du kan följa varje tjänst på statussidan
Statussidan visar aktuellt läge och 90 dagars historik för varje tjänst, och samma data finns som JSON för din egen övervakning.
Be oss om en partnernyckel i dag
Berätta vilka marknader du säljer på och vilka paneler du behöver, så skickar vi en nyckel med rätt behörigheter.
Den här sidan är en designskiss. Varje endpoint och payload på sidan kommer från docs.anivahealth.com, och pipelinediagrammet är illustrativt.
Maskinläsbara kopior av dokumentationen finns på docs.anivahealth.com/llms.txt och docs.anivahealth.com/llms-full.txt.