Co to jest API i jakie daje możliwości?
Publiczne API to narzędzie, które umożliwia automatyzację i usprawnienie codziennych procesów HR. Dzięki niemu możesz połączyć Calamari z innymi systemami, których już używacie w swojej firmie. API pozwala na przesyłanie i odbieranie danych w sposób automatyczny, eliminując potrzebę ręcznego wprowadzania informacji czy logowania się do systemu. To jak stworzenie mostu pomiędzy Calamari a innymi narzędziami, aby współpracowały ze sobą w pełni płynnie.
Dzięki integracji możesz np. przesyłać informacje o wnioskach, bilansie czasu pracy czy też automatyzować cykliczne generowanie i wysyłkę raportów.
Z uwagi na to, że publiczne API wymaga zbudowania infrastruktury, która będzie inicjować wysyłanie zapytań do aplikacji - sugerujemy zaangażowanie działu IT w organizacji, aby skutecznie powiązać Calamari z Waszymi aplikacjami.
Wszystkie niezbędne informacje do zbudowania integracji poprzez nasze API dostępne są na stronie developers.calamari.io
Do czego służy klucz API?
API Key to tzw. identyfikator pomiędzy Calamari, a systemem zewnętrznym. Aby móc korzystać z integracji API Calamari, należy wygenerować klucz API.
Jak znaleźć klucz API?
Wchodzimy w Konfiguracja → API → Włącz
Po włączeniu integracji masz możliwość wygenerowania potrzebnej ilosci kluczy API.
Tworzenie nowego klucza
W trakcie tworzenia nowych kluczy API, możesz zdecydować, czy klucz będzie pozwalał na komunikację z Calalari we wszystkich dostępnych zakresach, czy tylko wybranych funkcjach.
Przykład klucza pozwalającego na wykorzystanie wszystkich endpointów naszego publicznego API:
Przykład klucza pozwalającego np. wyłącznie na korzystanie z endpointów powiązanych z nieobecnościami (https://developers.calamari.io/#!/Absence_requests) :
W naszej dokumentacji znajdziesz dokładny opis każdego dostępnego endpointu ograniczonego do poszczególnego zakresu (np. Absence requests):
Ważne!
Po kliknięciu przycisku Generuj klucz - klucz API wyświetli się tylko raz, aby umożliwić Ci skopiowanie go i wykorzystanie go w odpowiednim narzędziu. Dzięki temu zwiększamy bezpieczeństwo i klucz nie jest w żaden sposób ponownie dostępny do skopniowania przez żadnego z administratorów.
Za każdym razem, gdy wyłączysz integrację API i włączysz ją ponownie, Twój klucz API ulegnie zmianie, co może mieć wpływ na niepoprawne działanie obecnej integracji.
Wskazówka:
Interfejs aplikacji pozwala na sprawdzenie podstawowych informacji o wygenerowanych kluczach.
Ponadto jeżeli któryś z kluczy nie był używany więcej niż 12 miesięcy - system zasugeruje weryfikacje, czy jest jeszcze potrzebny.
