Ugrás a fő tartalomhoz
Az Aniva Partner API egy REST API, amellyel az egészségügyi partnerek kezelhetik a páciensprofilokat, vérvételi időpontokat foglalhatnak a vizsgálati helyszíneken, és elindíthatják a laborrendelési folyamatokat. Az API-t HTTPS-en keresztül, a partneri API-kulcsoddal használhatod.

Mire használhatod

  • Profilkezelés — Hozz létre, kérj le és frissíts demográfiai páciensprofilokat.
  • Időpontfoglalás — Foglalj vérvételi időpontokat az Aniva vizsgálati helyszíneire.
  • Panelkezelés — Adj hozzá laborvizsgálati paneleket egy meglévő időponthoz, vagy távolíts el róla.
  • Egyedi biomarkerek — Adj hozzá egyedi biomarkereket egy időponthoz, vagy távolíts el róla panel kiválasztása nélkül.
  • Otthoni tesztkészlet-rendelések — Küldj postázott otthoni tesztkészletet a páciensnek, kövesd nyomon a csomagokat, és jelentsd, amikor a mintavétel megtörtént.
  • Panelkatalógus — Böngéssz az elérhető panelek között a GET /api/v1/panels végponttal a panelazonosítók és a hozzájuk tartozó biomarkerek megismeréséhez.
  • Biomarker-katalógus — Böngéssz a helyszínen vagy otthoni tesztkészletben rendelhető biomarkerek között a GET /api/v1/biomarkers végponttal az azonosítók megismeréséhez.
  • Vérvétel megerősítése — Küldd el a laborkódo(ka)t a vérvétel után a laborrendelési folyamat elindításához.
  • Laboreredmények — Kérd le a klinikai és genetikai eredményeket, és töltsd le a laborleletek PDF-fájljait.
  • Helyszínek keresése — Listázd az elérhető vizsgálati helyszíneket, hogy megjeleníthesd őket a pácienseknek.
  • Szállítási logisztika — Hozz létre, kövess nyomon, módosíts és mondj le futárszállítási megbízásokat.
  • Webhookok — Kapj HTTPS-hívást, ha egy időpont, egy otthoni tesztkészlet-rendelés, annak eredményei, egy helyszín, egy profil vagy egy szállítás megváltozik. Lásd: Webhookok.

Böngéssz a dokumentációban

Hitelesítés

Hitelesítsd a kéréseket a partneri API-kulcsoddal.

Gyors kezdés

Küldd el az első API-hívásodat percek alatt lépésről lépésre bemutatott példákkal.

Profilok

Ismerd meg, hogyan működnek a páciensprofilok és milyen adatokat tárolnak.

Időpontok

Ismerd meg az időpont életciklusát a foglalástól a megerősítésig.

Otthoni tesztkészlet-rendelések

Küldj tesztkészletet a páciens otthonába, és kövesd nyomon, amíg a minta megérkezik a laborba.

API-verziókezelés

Az API aktuális verziója a v1. Minden végpont a /api/v1/ előtaggal kezdődik. Az alap URL a https://anivahealth.com.
A visszafelé nem kompatibilis változtatások új verzióelőtag alatt jelennek meg. A v1 API továbbra is elérhető marad, és minden kivezetésről előre értesítést küldünk.

Dátumok és időzónák

Minden átvitt időpillanat UTC ISO 8601 formátumú (Z végződéssel). A csak naptári mezők helyi óraidő-elemeket használnak (YYYY-MM-DD, HH:MM). Konkrét megjegyzések:
  • A dátum- és időértéket váró bemeneteknek (pl. scheduled_at a POST / PATCH /api/v1/appointments végponton) tartalmazniuk kell időzóna-jelölőt — vagy Z-t, vagy explicit eltolást, például +02:00. Az időzóna nélküli értékeket az API 400 hibakóddal elutasítja. Mindkét forma ugyanazt az időpillanatot kódolja; a válasz a scheduled_at mezőt mindig UTC Z formátumban adja vissza. Megjelenítéshez használd a helyszín timezone mezőjét (vagy bármely más IANA-azonosítót), hogy az időpillanatot helyi óraidőre formázd.
  • A helyi óraidő bemenetek a célzott erőforrás időzónájában értelmeződnek: az elérhetőségi dátumok a timezone lekérdezési paramétert használják (alapértelmezetten a helyszín időzónáját); a szállítási pickup_date / pickup_time_* mezők a kiindulási helyszín időzónájában értelmeződnek.
  • A csak dátumot tartalmazó válaszmezők (pl. tested_at, elérhetőségi availability[].date) időzóna nélküli naptári dátumok.

Hozzáférés igénylése

Az API-kulcsokat az Aniva partnerenként állítja ki.
Lépj kapcsolatba az Anivával a partneri API-kulcsod igényléséhez.