Przejdź do głównej treści
Aniva Partner API to REST API, które pozwala partnerom medycznym zarządzać profilami pacjentów, umawiać wizyty na pobranie krwi w punktach pobrań oraz uruchamiać procesy zleceń laboratoryjnych. Z API komunikujesz się przez HTTPS, używając swojego partnerskiego klucza API.

Co możesz zrobić

  • Zarządzanie profilami — Twórz, pobieraj i aktualizuj profile demograficzne pacjentów.
  • Umawianie wizyt — Rezerwuj wizyty na pobranie krwi w punktach pobrań Aniva.
  • Zarządzanie panelami — Dodawaj lub usuwaj panele badań laboratoryjnych w ramach istniejącej wizyty.
  • Pojedyncze biomarkery — Dodawaj lub usuwaj pojedyncze biomarkery w ramach wizyty bez wybierania panelu.
  • Zamówienia domowych zestawów testowych — Wysyłaj pacjentowi domowy zestaw testowy, śledź jego przesyłki i zgłaszaj moment pobrania próbki.
  • Katalog paneli — Przeglądaj dostępne panele za pomocą GET /api/v1/panels, aby sprawdzić identyfikatory paneli i przypisane do nich biomarkery.
  • Katalog biomarkerów — Przeglądaj biomarkery, które możesz zamówić w lokalizacji lub w domowym zestawie testowym, za pomocą GET /api/v1/biomarkers, aby sprawdzić ich identyfikatory.
  • Potwierdzanie pobrania krwi — Prześlij kod (lub kody) laboratoryjne po pobraniu, aby uruchomić proces zlecenia laboratoryjnego.
  • Wyniki laboratoryjne — Pobieraj wyniki kliniczne i genetyczne oraz raporty laboratoryjne w formacie PDF.
  • Wyszukiwanie lokalizacji — Pobieraj listę dostępnych punktów pobrań, aby pokazać je pacjentom.
  • Logistyka przesyłek — Twórz, śledź, modyfikuj i anuluj zlecenia przesyłek kurierskich.
  • Webhooki — Otrzymuj wywołania HTTPS, gdy zmieni się wizyta, zamówienie domowego zestawu testowego, jego wyniki, lokalizacja, profil lub przesyłka. Zobacz Webhooki.

Poznaj dokumentację

Uwierzytelnianie

Uwierzytelniaj żądania za pomocą swojego partnerskiego klucza API.

Szybki start

Wykonaj swoje pierwsze wywołanie API w kilka minut dzięki przykładom krok po kroku.

Profile

Dowiedz się, jak działają profile pacjentów i jakie dane przechowują.

Wizyty

Poznaj cykl życia wizyty — od jej umówienia po potwierdzenie.

Zamówienia domowych zestawów testowych

Wyślij zestaw testowy do domu pacjenta i śledź go, aż próbka dotrze do laboratorium.

Wersjonowanie API

Bieżąca wersja API to v1. Wszystkie endpointy mają prefiks /api/v1/. Bazowy adres URL to https://anivahealth.com.
Zmiany niezgodne wstecznie będą wprowadzane pod nowym prefiksem wersji. API v1 pozostanie dostępne, a wszelkie wycofania będą ogłaszane z wyprzedzeniem.

Daty i strefy czasowe

Wszystkie punkty w czasie przesyłane w API są w formacie UTC ISO 8601 (sufiks Z). Pola czysto kalendarzowe używają składowych czasu zegarowego (YYYY-MM-DD, HH:MM). Szczegółowe uwagi:
  • Pola wejściowe przyjmujące datę i godzinę (np. scheduled_at w POST / PATCH /api/v1/appointments) muszą zawierać oznaczenie strefy czasowej — albo Z, albo jawne przesunięcie, np. +02:00. Daty bez strefy czasowej są odrzucane z kodem 400. Obie formy oznaczają ten sam punkt w czasie; odpowiedź zawsze zwraca scheduled_at w UTC jako Z. Użyj pola timezone lokalizacji (lub dowolnego innego identyfikatora IANA), aby podczas wyświetlania sformatować ten punkt w czasie jako lokalny czas zegarowy.
  • Pola wejściowe czasu zegarowego są interpretowane w strefie czasowej zasobu, którego dotyczą: daty dostępności korzystają z parametru zapytania timezone (domyślnie strefa czasowa lokalizacji), a pola przesyłki pickup_date / pickup_time_* są interpretowane w strefie czasowej lokalizacji nadania.
  • Pola odpowiedzi zawierające samą datę (np. tested_at, availability[].date w dostępności) to daty kalendarzowe bez strefy czasowej.

Uzyskiwanie dostępu

Aniva wydaje klucze API osobno dla każdego partnera.
Skontaktuj się z Aniva, aby otrzymać swój partnerski klucz API.