API partnerskie PetAssist

Dokumentacja API, na którym partner buduje własny frontend, korzystając z danych i funkcji PetAssist.

Co obejmuje integracja

Obszar	Dokument
Profile zwierząt	Profile zwierząt
Żywienie	Kalkulator żywieniowy
Prediagnoza	Prediagnoza
Książeczka zdrowia	Oś czasu, Pielęgnacja, Wizyty zewnętrzne, Leki, Wizyty u weterynarza
Czat z weterynarzem	Czat

Poza zakresem pozostają wideokonsultacje, baza wiedzy i PetAssist lokalnie.

Jak czytać tę dokumentację

Zaczynamy od zasad komunikacji — nagłówki, uwierzytelnienie, format błędów, limity i stronicowanie są wspólne dla całego API i pozostałe dokumenty zakładają, że są znane.

Potem użytkownicy, bo każde inne wywołanie wymaga identyfikatora użytkownika, i zwierzaki, bo do zwierzaka odnosi się cała reszta.

Dalsze moduły są niezależne i można je wdrażać w dowolnej kolejności.

Webhooki warto przeczytać wcześnie: to jedyny kanał, którym informujemy o zdarzeniach powstałych po naszej stronie, a bez ich obsługi część funkcji pozostanie dla użytkownika niewidoczna.

Trzy warstwy komunikacji

REST — wszystkie dane. Wywoływane z backendu partnera, kluczem API.

Socket.IO — czat na żywo. Nawiązywane z przeglądarki, uwierzytelniane osobnym krótkożyciowym tokenem, żeby klucz API nie opuszczał backendu partnera.

Webhooki — zdarzenia wychodzące od nas: odpowiedź weterynarza, przypomnienia, ankieta po wizycie.

Środowisko testowe

Interaktywna dokumentacja OpenAPI działa pod /partner-api. Po wpisaniu poświadczeń w oknie „Authorize" można przejść pełny przebieg — od założenia użytkownika po wszystkie moduły — bez pisania kodu.

Adresy i poświadczenia przekazujemy osobno.