Co to jest API i jakie możliwości daje?
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 automatyczne przesyłanie i odbieranie danych, eliminując potrzebę ręcznego wprowadzania informacji lub logowania 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 lub 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. API w Calamari pozwala na dostęp do API na poziomie całego konta organizacji. Aby móc korzystać z integracji API Calamari, należy wygenerować klucz API.
Gdzie mogę znaleźć klucz API?
Wchodzimy w Konfiguracja → API → Włącz
Po włączeniu integracji możesz wygenerować klucze 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 w wybranych funkcjach. Pamiętaj, że publiczne API Calamari działa na poziomie całego konta organizacji, a nie w kontekście konkretnego użytkownika.
⚠️ 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 skopiowania 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 spowodować nieprawidłowe działanie obecnej integracji.
Przykład klucza pozwalającego na wykorzystanie wszystkich endpointów naszego publicznego API:
Przykład klucza pozwalającego wyłącznie na korzystanie z endpointów powiązanych z nieobecnościami
💡 Szukasz rozwiązania działającego w kontekście konkretnego użytkownika?
MCP Server działa w kontekście konkretnego użytkownika. Może być lepszym rozwiązaniem, gdy pracownik lub manager chce korzystać z Calamari za pośrednictwem kompatybilnego narzędzia AI. Dostęp pozostaje wtedy zgodny z rolą i uprawnieniami użytkownika w Calamari.
MCP Server obsługuje wybrane działania, dlatego nie w każdym przypadku zastąpi integrację przygotowaną z wykorzystaniem publicznego API.
Dowiedz się więcej: MCP Server w Calamari — jak działa integracja z AI i jak ją włączyć?
Dokumentacja API
W naszej dokumentacji developers.calamari.io znajdziesz dokładny opis każdego dostępnego endpointu ograniczonego do poszczególnego zakresu (np. Absence requests):
Zasady działania i informacje o zwracanych komunikatach są opisane w Usage Guidelines: https://developers.calamari.dev/pages/usage-guidelines
Zarządzanie kluczami
Interfejs aplikacji pozwala sprawdzić podstawowe informacje o wygenerowanych kluczach w Konfiguracja → API
Ponadto, jeżeli któryś z kluczy nie był używany więcej niż 12 miesięcy - system zasugeruje weryfikację, czy jest jeszcze potrzebny.
