Eén API-sleutel geeft je 45 endpoints, van boeking tot labresultaten
De Aniva Partner API boekt een bloedafname op meer dan 25 locaties in Duitsland, voegt panels toe aan die afspraak en geeft klinische en genetische resultaten terug als JSON. Elk verzoek heeft één header nodig en de basis-URL is in elke omgeving hetzelfde.
Wanneer je Aniva gebruikt
45 endpoints zijn vandaag gedocumenteerd en live
Authenticatie heeft maar één request-header nodig
Elk pad begint met de v1-prefix
Duitse locaties kunnen de bloedafname doen
Vier verzoeken lopen van boeking tot labresultaten
Elk verzoek geeft de ID terug die het volgende verzoek nodig heeft, dus een basisintegratie bestaat uit vier verzoeken voordat je panels, herplanningen of koeriers toevoegt.
Je haalt de locaties op die je sleutel kan boeken
De response geeft je elk adres, de openingstijden en de tijdzone, zodat een klant alleen tijdsloten ziet die bestaan.
Je maakt een profiel aan voor de klant
Een profiel heeft een naam, een geslachtscode, een geboortedatum en je profile_group nodig, die een UUID of je eigen slug accepteert.
Je boekt de afspraak op een gekozen tijdstip
Voor de boeking zijn het profiel-ID, het locatie-ID en een ISO 8601-datumtijd met bijbehorende offset of het Z-achtervoegsel nodig.
Je bevestigt de bloedafname met de barcode van de kit
Dit verzoek start de labopdracht en legt de afspraak vast, dus pas elk panel aan voordat je het verstuurt.
Elke resourcegroep is één REST-collectie
Je kunt een bloedafname bij een kliniek bestellen, of een thuistestkit per post. Beide komen terug in hetzelfde formaat, dus je schrijft de code die resultaten uitleest maar één keer.
Een profiel is de persoon die je test
Je zoekt een profiel op via e-mail, maakt het aan onder je profielgroep en werkt de demografische gegevens later bij.
Een afspraak bevat de panels en de bloedafname
Vijftien endpoints dekken de boeking en elke latere wijziging daarvan, inclusief panels, containerpreviews en de bevestiging.
Bestellingen van thuistestkits zijn de versie per post
Tien endpoints vragen een thuistestkit voor een profiel aan, passen de panels ervan aan en geven dezelfde resultaatstructuur terug.
Locaties laten je zien waar een bloedafname plaatsvindt
Je leest de locaties uit die je sleutel kan boeken en vraagt er vervolgens een om de boekbare starttijden.
Resultaten komen terug als klinische en genetische rijen
Elk ordertype heeft een eigen aanroep voor de resultaten, en het pdf-rapport is een aparte download via bestands-ID.
Een koerier brengt het monster naar het laboratorium
Je maakt een koeriersopdracht aan met een ophaaltijdvak op een werkdag, koppelt afspraken en bekijkt de statusupdates.
Catalogi tonen de biomarkers die je kunt bestellen
De catalogi voor biomarkers, panels en eenheden zijn gepagineerd, en je kunt biomarkers filteren op testlocatie.
Eén readiness-endpoint heeft geen API-key nodig
De readiness probe heeft geen API-sleutel nodig, zodat je uptime-monitor deze volgens een schema kan aanroepen.
Het labproces start zodra je de bloedafname bevestigt
Je stuurt ons de barcode van de kit, en dat is het laatste wat we van je nodig hebben. Wij regelen daarna de verpakkingen, de koerier en het laboratorium, zodat je code maar twee endpoints hoeft aan te roepen tot het rapport klaar is.
Elk resultaat heeft twee referentiebereiken en vier statussen
Elke klinische rij bevat het bereik dat het laboratorium heeft gerapporteerd en het Aniva-bereik met het optimale venster, zodat je beide kunt weergeven zonder zelf een opzoektabel bij te houden.
Datum-tijdwaarden hebben een tijdzone nodig, anders mislukt het verzoek
Een naïeve datetime wordt afgewezen met 400, de fout die de meeste eerste integraties maken.
Voor elk verzoek is je partner-API-sleutel nodig
Authenticatie gebruikt bij elke aanroep de header x-api-key, en een ontbrekende of geroteerde sleutel geeft 403 terug met een korte JSON-foutmelding.
Je kunt elke dienst volgen op de statuspagina
De statuspagina toont de actuele status en 90 dagen geschiedenis per dienst, en dezelfde gegevens zijn beschikbaar als JSON voor je eigen monitor.
Vandaag een partnersleutel bij ons aanvragen
Laat ons weten in welke markten je verkoopt en welke panels je nodig hebt, dan sturen we een sleutel met de juiste rechten.
Deze pagina is een ontwerp-mockup. Elk endpoint en elke payload erop komt van docs.anivahealth.com en het pipelinediagram is illustratief.
Machineleesbare kopieën van de documentatie staan op docs.anivahealth.com/llms.txt en docs.anivahealth.com/llms-full.txt.