Jeden API kľúč ti sprístupní 45 endpointov, od rezervácie až po laboratórne výsledky
Aniva Partner API rezervuje odber krvi na viac ako 25 miestach v Nemecku, pridáva k tomuto termínu panely a vracia klinické a genetické výsledky vo formáte JSON. Každá požiadavka potrebuje jednu hlavičku a základná URL je v každom prostredí rovnaká.
Kedy použiť Aniva
45 endpointov je dnes zdokumentovaných a v prevádzke
Na autentifikáciu stačí jedna hlavička požiadavky
Každá cesta sa začína predponou v1
Nemecké pobočky môžu urobiť odber krvi
Od rezervácie po výsledky z laboratória vedú štyri požiadavky
Každá požiadavka vráti ID, ktoré potrebuje nasledujúca, takže základná integrácia sú štyri požiadavky, kým pridáš panely, zmeny termínov alebo kuriérov.
Vypíšeš si miesta, ktoré môže tvoj kľúč rezervovať
Odpoveď ti vráti každú adresu, otváracie hodiny a časové pásmo, takže zákazník vidí len existujúce termíny.
Vytvoríš zákazníkovi profil
Profil potrebuje meno, kód pohlavia, dátum narodenia a tvoj profile_group, ktorý prijíma UUID alebo tvoj vlastný slug.
Rezervuješ si termín na vybraný čas
Rezervácia vyžaduje ID profilu, ID lokality a dátum s časom vo formáte ISO 8601 s časovým posunom alebo príponou Z.
Odber krvi potvrdíš čiarovým kódom súpravy
Táto požiadavka spustí laboratórnu objednávku a uzamkne termín, takže každý panel zmeň pred jej odoslaním.
Každá skupina zdrojov je jedna REST kolekcia
Môžeš objednať odber krvi na klinike alebo domácu testovaciu súpravu poštou. Oboje príde v rovnakom formáte, takže kód na čítanie výsledkov napíšeš len raz.
Profil je osoba, ktorú testuješ
Profil vyhľadáš podľa e-mailu, vytvoríš ho v rámci svojej skupiny profilov a demografické údaje doplníš neskôr.
Termín zahŕňa panely aj odber krvi
Pätnásť endpointov pokrýva rezerváciu aj každú jej neskoršiu zmenu vrátane panelov, náhľadov odberových nádob a potvrdenia.
Objednávky domácich testovacích súprav sú poštová verzia
Desať endpointov vyžiada domácu súpravu pre profil, zmení jeho panely a vráti rovnakú štruktúru výsledkov.
Lokality ti ukážu, kde prebieha odber krvi
Načítaš miesta, na ktorých môže tvoj kľúč rezervovať, a potom si od jedného z nich vyžiadaš začiatky voľných termínov.
Výsledky prichádzajú ako klinické a genetické riadky
Každý typ objednávky má vlastné volanie pre výsledky a PDF správa sa sťahuje samostatne podľa ID súboru.
Kuriér odvezie vzorku do laboratória
Vytvoríš objednávku kuriéra s časovým oknom vyzdvihnutia v pracovný deň, potom priradíš termíny a sleduješ aktualizácie jej stavu.
Katalógy uvádzajú biomarkery, ktoré si môžeš objednať
Katalógy biomarkerov, panelov a jednotiek sú stránkované a biomarkery môžeš filtrovať podľa miesta testovania.
Jeden endpoint pripravenosti nepotrebuje API kľúč
Sonda pripravenosti nevyžaduje žiadny API kľúč, takže ju tvoj monitor dostupnosti môže volať podľa plánu.
Laboratórny proces sa spustí, keď potvrdíš odber krvi
Pošleš nám čiarový kód súpravy a to je posledná vec, ktorú od teba potrebujeme. My potom zorganizujeme nádoby, kuriéra a laboratórium, takže tvoj kód volá len dva endpointy, kým nie je správa hotová.
Každý výsledok má dve referenčné rozmedzia a štyri stavy
Každý klinický riadok obsahuje rozmedzie, ktoré uviedlo laboratórium, aj rozmedzie Aniva s jeho optimálnym pásmom, takže môžeš zobraziť obe bez udržiavania vlastnej vyhľadávacej tabuľky.
Dátumy a časy vyžadujú časové pásmo, inak požiadavka zlyhá
Dátum a čas bez časovej zóny systém zamietne kódom 400, čo je chyba, ktorú robí väčšina prvých integrácií.
Každá požiadavka potrebuje tvoj partnerský API kľúč
Autentifikácia používa hlavičku x-api-key pri každom volaní a chýbajúci alebo obmenený kľúč vráti 403 s krátkou chybou JSON.
Každú službu môžeš sledovať na stránke stavu služieb
Stavová stránka zobrazuje aktuálny stav a históriu za 90 dní pre každú službu a tie isté údaje sú dostupné ako JSON pre tvoj vlastný monitoring.
Požiadať o partnerský kľúč ešte dnes
Povedz nám, na ktorých trhoch predávaš a ktoré panely potrebuješ, a pošleme ti kľúč so správnymi oprávneniami.
Táto stránka je dizajnový návrh. Každý endpoint a payload na nej pochádza z docs.anivahealth.com a diagram pipeline je ilustračný.
Strojovo čitateľné kópie dokumentácie sú na docs.anivahealth.com/llms.txt a docs.anivahealth.com/llms-full.txt.