Mit einem API-Schlüssel hast du Zugriff auf 45 Endpunkte – von der Buchung bis zu den Laborergebnissen
Die „ Aniva “-Partner-API bucht einen „ Blutabnahme “ an über 25 Standorten in Deutschland, fügt diesem Termin Untersuchungsparameter hinzu und gibt klinische und genetische Ergebnisse als JSON zurück. Jede Anfrage benötigt einen Header, und die Basis-URL ist in jeder Umgebung dieselbe.
Wann man es benutzt Aniva
45 Endpunkte sind dokumentiert und werden derzeit genutzt
Für die Authentifizierung ist nur ein Request-Header nötig
Jeder Pfad beginnt mit dem Präfix „v1“
Deutsche Standorte können das Blutabnahme
Vier Anfragen – von der Buchung bis zu den Laborergebnissen
Jede Anfrage gibt die ID zurück, die die nächste benötigt; eine einfache Integration erfordert also vier Anfragen, bevor du Termine, Umplanungen oder Kuriere hinzufügen kannst.
Du gibst die Standorte an, die mit deinem Schlüssel gebucht werden können
Die Antwort enthält jeweils die Adresse, die Öffnungszeiten und die Zeitzone, sodass ein Kunde nur verfügbare Termine sieht.
Du erstellst ein Profil für den Kunden
Ein Profil benötigt einen Namen, einen Geschlechtscode, ein Geburtsdatum und deine „profile_group“, die eine UUID oder deinen eigenen Slug akzeptiert.
Du buchst den Termin in einem ausgewählten Zeitfenster
Für die Buchung werden die Profil-ID, die Standort-ID und ein Datums-/Zeitangabeformat nach ISO 8601 mit dem entsprechenden Offset oder dem Suffix „Z“ benötigt.
Du bestätigst die Entnahme mit dem Barcode des Kits
Diese Anfrage löst den Laborauftrag aus und legt den Termin fest. Ändere daher alle Testpanels, bevor du die Anfrage absendest.
Jede Ressourcengruppe ist eine REST-Sammlung
Du kannst einen „ Blutabnahme “ in einer Klinik bestellen oder ein Testset per Post nach Hause schicken lassen. Beide werden im gleichen Format zurückgeschickt, sodass du den Code zum Auslesen der Ergebnisse nur einmal eingeben musst.
Ein Profil ist die Person, die du testest
Du suchst ein Profil per E-Mail heraus, legst es unter deiner Profilgruppe an und füllst die demografischen Daten später nach.
Ein Spielplan enthält die Gruppen und die Auslosung
Fünfzehn Endpunkte decken die Buchung und jede spätere Änderung daran ab, einschließlich der Übersichtsmasken, der Container-Vorschau und der Bestätigung.
Bestellungen für Heimtrikots sind die Versandversion
Zehn Endpunkte fordern ein DIY-Set für ein Profil an, tauschen dessen Paneele aus und geben dieselbe Ergebnisform zurück.
Die Standorte geben an, wo eine Ziehung stattfindet
Du schaust dir die Standorte an, die du mit deinem Schlüssel buchen kannst, und fragst dann bei einem davon nach den verfügbaren Buchungszeiträumen.
Die Ergebnisse führen zu klinischen und genetischen Kontroversen
Jede Auftragsart hat ihren eigenen Ergebnisabruf, und der PDF-Bericht ist ein separater Download nach Datei-ID.
Ein Kurier bringt die Probe ins Labor
Du erstellst einen Kurierauftrag mit einem Abholzeitfenster an einem Wochentag, fügst dann Termine hinzu und verfolgst die Statusaktualisierungen.
In den Katalogen sind die Biomarker aufgeführt, die du bestellen kannst
Die Kataloge für Biomarker, Testpanels und Einheiten sind paginiert, und du kannst die Biomarker nach Teststandort filtern.
Ein Readiness-Endpunkt benötigt keinen API-Schlüssel
Die Verfügbarkeitsprüfung benötigt keinen API-Schlüssel, sodass dein Verfügbarkeitsmonitor sie nach einem Zeitplan aufrufen kann.
Der Laborablauf beginnt, sobald du die Blutentnahme bestätigst
Du schickst uns den Barcode des Testkits, und das ist schon alles, was wir von dir brauchen. Wir kümmern uns dann um die Behälter, den Kurierdienst und das Labor, sodass dein Code nur zwei Schritte durchläuft, bis der Befund fertig ist.
Jedes Ergebnis hat zwei Referenzbereiche und vier Statusangaben
Jede klinische Zeile enthält den vom Labor angegebenen Bereich sowie den Bereich „ Aniva “ mit dem entsprechenden „ optimal “-Fenster, sodass du beides anzeigen kannst, ohne eine eigene Nachschlagetabelle führen zu müssen.
Datums- und Zeitangaben müssen eine Zeitzone enthalten, sonst schlägt die Anfrage fehl
Ein „naives“ Datums- und Zeitformat wird mit dem Status 400 abgelehnt – das ist der häufigste Fehler, den die meisten bei ihrer ersten Integration machen.
Für jede Anfrage wird dein Partner-API-Schlüssel benötigt
Bei der Authentifizierung wird bei jedem Aufruf der Header „x-api-key“ verwendet. Fehlt der Schlüssel oder wurde er aktualisiert, wird ein 403-Fehler mit einer kurzen JSON-Fehlermeldung zurückgegeben.
Auf der Statusseite kannst du jeden Dienst verfolgen
Die Statusseite zeigt den aktuellen Status und den Verlauf der letzten 90 Tage für jeden Dienst an; dieselben Daten stehen dir im JSON-Format für deine eigene Überwachung zur Verfügung.
Frag uns noch heute nach einem Partnerschlüssel
Sag uns einfach, in welchen Märkten du verkaufst und welche Panels du brauchst, und wir schicken dir einen Schlüssel mit den passenden Berechtigungen.
Diese Seite ist ein Design-Entwurf. Alle darin aufgeführten Endpunkte und Payloads stammen von docs.anivahealth.com, und das Pipeline-Diagramm dient nur zur Veranschaulichung.
Maschinenlesbare Kopien der Dokumentation findest du unter docs.anivahealth.com/llms.txt und docs.anivahealth.com/llms-full.txt.