Dokumentacja · API

API dla integratorów

API Clinidesk obsługuje dane pacjentów, wizyt, skierowań i rozliczeń. Przy planowaniu połączenia z innym systemem ustalamy, jakie dane mają przepływać, w którym kierunku i kto odpowiada za ich aktualizację.

Zasoby REST i format danych

Aplikacja korzysta z API REST pod ścieżką /api. Dane są wymieniane w formacie JSON, a dostępne operacje zależą od zasobu: mogą obejmować odczyt, tworzenie, zmianę lub usunięcie rekordu. Nie każda operacja jest dostępna dla każdego obiektu.

Przed wdrożeniem integracji ustalamy wymagane endpointy, formaty pól, identyfikatory, zasady stronicowania i obsługę błędów. Pozwala to określić, które funkcje istnieją, a które wymagają przygotowania dla danego połączenia.

Aktualizacje danych

Clinidesk używa uwierzytelnionego połączenia w czasie rzeczywistym do aktualizacji terminarza i skrzynki zgłoszeń w aplikacji. Sposób przekazywania zmian do zewnętrznego systemu ustalamy osobno, z uwzględnieniem ponawiania operacji i uzupełniania danych po przerwie w połączeniu.

Uwierzytelnianie i uprawnienia

API panelu personelu korzysta z uwierzytelniania JWT. Wybrane operacje wymagają dodatkowo odpowiedniej roli użytkownika. Sposób dostępu dla integracji i zakres dozwolonych działań wymagają ustalenia przed jej uruchomieniem.

Portal pacjenta ma osobne uwierzytelnianie i endpointy. Dostęp do wizyt i plików pacjenta jest sprawdzany względem konta zalogowanego w portalu.

Jak przygotować integrację

Opisz system, z którym chcesz połączyć Clinidesk, oraz konkretny proces: np. przekazanie rezerwacji, pobranie dokumentów sprzedaży lub zasilenie raportu. Dodaj listę potrzebnych danych, kierunek ich przepływu i oczekiwaną częstotliwość aktualizacji. Na tej podstawie uzgodnimy zakres i sposób testowania połączenia.

Opisz potrzebną integrację Sprawdź dostępne integracje →