Bluttanalysen aus dengem eegene Produkt reservéieren

Een API-Schlëssel gëtt dir 45 Endpunkten, vun der Reservatioun bis bei d'Laboratoiresresultater

D'Aniva Partner API reservéiert eng Bluttentnam op iwwer 25 Standuerter an Däitschland, setzt Panels bei dee Rendez-vous derbäi a liwwert klinesch a geneetesch Resultater als JSON zeréck. All Ufro brauch een Header, an d'Basis-URL ass an all Ëmfeld déi selwecht.

Wéini Aniva benotzen

Notz Aniva, wann deng Clienten eng Bluttanalys reservéiere mussen
Benotz d'Rendez-vous-Endpunkte fir eng Bluttentnam an der Praxis an d'Endpunkte vum Testkit fir doheem fir e Kit per Post.
Benotz d'Resultater-Endpoints fir klinesch Zeilen, genetesch Zeilen an de PDF-Rapport.
Benotz d'Katalog-Endpunkten, fir d'Biomarker, Panels an Eenheeten auszeliesen, déi Aniva verkeeft.
Benotz déi dokumentéiert Paden ënner https://anivahealth.com/api/v1/ an denk där keng Endpoints aus.
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"
  }'
De Grondoflaf besteet aus véier Ufroen
GET /locations POST /profiles POST /appointments POST /appointments/{id}/confirm
45

45 Endpunkte sinn haut dokumentéiert a live

1

D'Authentifizéierung brauch nëmmen ee Request-Header

v1

All Pad fänkt mam v1-Prefix un

25+

Däitsch Standuerter kënnen d'Bluttentnam maachen

Véier Ufroe bauen eng funktionéierend Integratioun op

Véier Ufroe féiere vun der Reservatioun bis bei d'Resultater aus dem Laboratoire

All Ufro gëtt d'ID zréck, déi déi nächst brauch, sou datt eng Basisintegratioun aus véier Ufroe besteet, ier s du Panels, Ëmbuchungen oder Courrieren derbäisetzs.

Schrëtt 01 · GET /locations

Du lëschts d'Standuerter op, déi däi Schlëssel reservéiere kann

D'Äntwert liwwert där all Adress, d'Ëffnungszäiten an d'Zäitzon, sou datt e Client nëmmen Terminer gesäit, déi existéieren.

Tester
Schrëtt 02 · POST /profiles

Du lees e Profil fir de Client un

E Profil brauch en Numm, e Geschlechtscode, e Gebuertsdatum an deng profile_group, déi eng UUID oder däin eegene Slug akzeptéiert.

Tester
Schrëtt 03 · POST /appointments

Du reservéiers de Rendez-vous zu enger gewielter Zäit

D'Reservéierung brauch d'Profil-ID, d'Standuert-ID an Datum an Auerzäit am ISO-8601-Format mat Offset oder dem Z-Suffix.

Tester
Schrëtt 04 · POST /appointments/{id}/confirm

Du bestätegs d'Bluttentnam mam Barcode vum Kit

Dës Ufro start den Optrag am Laboratoire a spärt de Rendez-vous, dofir änner all Panel, ier s du se fortschécks.

Tester
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"
  }'
Fäegkeet

All Ressourcegrupp ass eng REST-Kollektioun

Du kanns eng Bluttentnam an enger Praxis oder en Testkit fir doheem mat der Post bestellen. Béid kommen am selwechte Format zeréck, sou datt s du de Code, deen d'Resultater liest, nëmmen eemol schreiwe muss.

Profiller · 4 Endpunkten

E Profil ass déi Persoun, déi s du tests

Du sichs e Profil iwwer d'E-Mail-Adress eraus, lees et ënnert denger Profilgrupp un an ergänz d'demografesch Date spéider.

Tester
GET /profiles
PATCH /profiles/{id}
Rendez-vousen · 15 Endpunkten

Zu engem Rendez-vous gehéieren d'Panelen an d'Bluttentnam

Fofzéng Endpunkten decken d'Reservatioun an all spéider Ännerung dovun of, inklusiv Panelen, Behältervirschauen an d'Bestätegung.

Tester
POST /appointments
GET /appointments/{id}/results
Bestellunge fir Testkits fir doheem · 10 Endpunkten

Bestellunge vun Testkits fir doheem sinn d'Postversioun

Zéng Endpunkter froen en DIY-Kit fir e Profil un, ännere seng Panels a ginn déiselwecht Resultatform zeréck.

Tester
Kit-Bestellung uleeën
Resultater kréien
Standuerter · 2 Endpunkten

Standuerter weisen där, wou eng Bluttentnam stattfënnt

Du liest d'Standuerter aus, déi däi Schlëssel buche kann, a frees dann ee vun hinnen no senge buchbare Startzäiten.

Tester
GET /locations
GET /locations/{id}/availability
Dokumenter · 1 Endpunkt

D'Resultater kommen als klinesch a genetesch Zeilen zeréck

All Bestellungstyp huet säin eegenen Opruff fir d'Resultater, an de PDF-Rapport ass e separaten Download iwwer d'Datei-ID.

Tester
GET /appointments/{id}/results
GET /documents/{id}
Sendungen · 8 Endpunkten

E Courrier bréngt d'Prouf an de Laboratoire

Du erstells eng Courrier-Commande mat engem Zäitfenster fir d'Ofhuelung ënner der Woch, hänks Rendez-vousen un a liest seng Status-Updates.

Tester
POST /shipments
Rendez-vousen unhängen
Kataloger · 4 Endpunkten

Kataloge lëschten d'Biomarker op, déi s du bestelle kanns

D'Kataloge fir Biomarker, Panels an Eenheete si paginéiert, an du kanns Biomarker no Teststanduert filteren.

Tester
GET /biomarkers
GET /panels
Gesondheet · 1 Endpunkt

Ee Readiness-Endpunkt brauch keen API-Schlëssel

D'Readiness-Probe brauch keen API-Schlëssel, sou datt däin Uptime-Monitor se no Zäitplang opruffe kann.

Tester
Ëffentleche Bereetschaftstest
Deng Aarbecht hält bei der Barcode-Bestätegung op

De Labosprozess fänkt un, wann s du d'Bluttentnam bestätegs

Du schécks eis de Kit-Barcode, an dat ass dat Lescht, wat mir vun dir brauchen. Mir organiséieren dann d'Behälter, de Courrier an de Laboratoire, sou datt däi Code nëmmen zwee Endpoints oprifft, bis de Rapport fäerdeg ass.

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
E gefëllte Punkt ass de Wee, deen s du wëlls.E Rank ass en Zoustand, ëm deen s du dech nach këmmers.Orange Linne sinn déi confirméiert Bestellung.
Ee Parser liest eng Bluttentnam an der Klinik an en Testkit fir doheem

All Resultat huet zwee Referenzberäicher a véier Statussen

All klinesch Zeil enthält de Beräich, deen de Laboratoire gemellt huet, an den Aniva-Beräich mat senger optimaler Fënster, sou datts du béid uweise kanns, ouni eng eege Lookup-Tabell ze féieren.

Eng Zeil steet op geplangt, ier de Laboratoire se analyséiert.
Eng Zeil weist empfaangen un, soubal e Wäert an eng Eenheet zeréckkommen.
An enger Zeil steet fault, wann de Laboratoire d'Ufro annuléiert huet, a status_reason erkläert et.
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" }]
}
D'API benotzt dräi Zäitformater

Datums- an Zäitangabe brauchen eng Zäitzon, soss schléit d'Ufro feel

En naiven Datetime gëtt mat 400 ofgewisen – dat ass dee Feeler, deen déi meescht éischt Integratioune maachen.

Zäitstempele kommen ëmmer als UTC zeréck, no ISO 8601 mam Z-Suffix.
Agabe mussen en explizitten Offset enthalen, soudatt eng Reservatioun 2026-05-15T12:30:00+02:00 akzeptéiert.
Updates zu der Liwwerung halen den Offset bäi, deen de Logistikprestataire gemellt huet.
Kalennerfelder si reng Wandauer-Zäit, wéi e Gebuertsdatum.
Aniva stellt all Partnerschlëssel aus a rotéiert en

All Ufro brauch däi Partner-API-Schlëssel

D'Authentifizéierung benotzt den Header x-api-key bei all Uruff, an e feelenden oder rotéierte Schlëssel gëtt 403 mat engem kuerze JSON-Feeler zeréck.

Däi Schlëssel entscheet, wéi eng Standuerter, Rendez-vousen a Liwwerungen du gesi kanns.
Gëff däin API-Key ni am Client-Code oder an ëffentleche Repositories präis.
Eng ëffentlech Testufro brauch keen API-Schlëssel

Du kanns all Service op der Statussäit verfollegen

D'Statussäit weist den aktuelle Stand an 90 Deeg Historique fir all Service, an déiselwecht Date sinn als JSON fir däin eegene Monitor disponibel.

Partnerschlëssele gi vun eisem Team ausgestallt

Haut nach e Partnerschlëssel bei eis ufroen

So eis, op wéi enge Mäert du verkeefs a wéi eng Panels du brauchs, a mir schécken där e Schlëssel mat de richtege Berechtegungen.

Du kanns och d'OpenAPI-Datei eroflueden

Dës Säit ass en Design-Mockup. All Endpoint an all Payload drop kënnt vun docs.anivahealth.com, an d'Pipeline-Diagramm ass illustrativ.

Maschinneliesbar Kopië vun der Dokumentatioun stinn op docs.anivahealth.com/llms.txt an docs.anivahealth.com/llms-full.txt.