Oficjalna dokumentacja API HRappka dostępna jest pod adresem:
Dokumentacja jest na bieżąco aktualizowana i stanowi jedyne obowiązujące źródło informacji o dostępnych endpointach, parametrach oraz strukturze danych zwracanych przez API.
Jak uzyskać dostęp do API? #
Aby rozpocząć korzystanie z API, należy wypełnić formularz zgłoszeniowy:
W formularzu znajdują się wszystkie aktualnie dostępne endpointy. Podczas zgłoszenia należy wskazać, z których endpointów planują Państwo korzystać.
Aktualizacje dokumentacji #
Dokumentacja API jest utrzymywana w sposób centralny i aktualizowana wraz ze zmianami w systemie. Oznacza to, że:
- nowe endpointy będą publikowane bezpośrednio w dokumentacji,
- zmiany w istniejących endpointach będą odzwierciedlane na bieżąco,
- wszelkie modyfikacje w kodzie lub sposobie działania API będą uwzględniane w dokumentacji technicznej.
Ważne informacje #
- Wszystkie oficjalnie wspierane endpointy są dostępne w dokumentacji API oraz formularzu zgłoszeniowym.
- Przed rozpoczęciem integracji wymagane jest przesłanie formularza zgłoszeniowego.
- W przypadku rozszerzenia zakresu integracji o kolejne endpointy może być wymagane wysłanie zgłoszenia do zespołu wsparcia w celu ich rozszerzenia.