Dostęp do API #

API umożliwia integrację systemu Proassist z zewnętrznymi systemami klienta, takimi jak CRM, system do rejestracji online, systemy rozliczeń, aplikacje własne czy narzędzia automatyzujące pracę placówki. Dzięki temu możliwa jest wymiana danych pomiędzy systemami oraz automatyzacja procesów.

Aby uzyskać dostęp do API, należy skontaktować się z działem pomocy technicznej. Zespół wsparcia aktywuje dostęp oraz przekazuje dane niezbędne do konfiguracji:

klucz API
username (nazwa placówki)

📘 Dokumentacja API (środowisko produkcyjne):
https://api.proassist.pl/api

Klient otrzymuje również dostęp do środowiska testowego, które umożliwia bezpieczne sprawdzenie integracji przed wdrożeniem.

Po aktywacji API administrator placówki ma możliwość w każdej chwili:

podglądu i pobrania klucza API,
zarządzania dostępem do integracji.

Dane te znajdują się w ustawieniach kontrahenta. W tym celu przejdź do zakładki PLACÓWKI w menu bocznym, a następnie wybierz KONTRAHENCI i kliknij ikonę edycji przy wybranej pozycji. W wysuwanym panelu przejdź do sekcji Konfiguracja API, gdzie dostępne są dane API.

Reset klucza API #

Wygenerowanie nowego PROASSIST_API_KEY powoduje natychmiastowe unieważnienie poprzedniego klucza.

Oznacza to, że:

wszystkie integracje korzystające ze starego klucza przestaną działać,
systemy używające poprzedniego klucza utracą możliwość komunikacji z API,
konieczna będzie aktualizacja konfiguracji po stronie klienta.

Limity requestów i powiadomienia #

Korzystanie z API odbywa się w ramach miesięcznego limitu requestów określonego w wybranym pakiecie.

Limit requestów obowiązuje od 1. do ostatniego dnia każdego miesiąca.
Po wykorzystaniu 90% limitu otrzymasz powiadomienie e-mail.
Po wykorzystaniu 100% limitu otrzymasz kolejne powiadomienie e-mail.
Powiadomienia są wysyłane na adres e-mail przypisany do konta Proassist, na który otrzymujesz również faktury.

Jak wyglądają powiadomienia?

Poniżej znajdziesz przykładowe wiadomości e-mail, które otrzymasz po wykorzystaniu 90% oraz 100% dostępnego limitu requestów.

Zmiana limitu #

Jeżeli w trakcie miesiąca okaże się, że potrzebujesz większego limitu, możesz zmienić pakiet.

W celu zmiany limitu skontaktuj się ze swoim opiekunem klienta lub Działem Pomocy Technicznej.

Zmiana limitu zostanie zastosowana w ciągu maksymalnie 15 minut.