Jak korzystać z Open API?

Nasz dodatek Open API łączy Vacation Tracker z Twoimi własnymi narzędziami. Utwórz klucz API, wybierz, co może robić, i używaj go do odczytywania i zmieniania danych lub do otrzymywania powiadomień, gdy coś się zmieni.

Jak utworzyć klucz API

1. Zaloguj się do swojego konta Vacation Tracker na app.vacationtracker.io/signin.
2. Otwórz Integracje w menu po lewej stronie (w sekcji Ustawienia przestrzeni roboczej).
3. Kliknij kartę API. Otworzy się strona Open API.
4. W sekcji Klucze API kliknij Utwórz klucz API.
5. Wpisz Nazwę klucza. Tę nazwę widzą tylko osoby z Twojej firmy.
6. Opcjonalnie wpisz Nazwę integracji. Jest ona widoczna w Vacation Tracker przy każdej zmianie wprowadzonej przez klucz, na przykład „Zatwierdzone przez Jane (przez synchronizację płac)”. Pozostaw to pole puste, aby wyświetlać tylko imię i nazwisko osoby.
7. W sekcji Uprawnienia wybierz szablon i w razie potrzeby go dostosuj (zobacz poniżej).
8. W sekcji Wygaśnięcie wybierz, kiedy klucz wygaśnie: za 30 dni, za 90 dni, za 1 rok (zalecane) lub nigdy.
9. Sprawdź Podsumowanie i kliknij Utwórz klucz API.
10. Skopiuj klucz i przechowuj go w bezpiecznym miejscu. Pełny klucz jest wyświetlany tylko raz, w chwili utworzenia.

Wybór uprawnień

Zacznij od szablonu, a następnie go dostosuj:

• Tylko odczyt: wgląd w dane bez możliwości zmian. Dobre do raportów i pulpitów.
• Zarządzanie urlopami: składanie wniosków, dodawanie i zatwierdzanie urlopów. Odczyt użytkowników i typów urlopów.
• Konfiguracja przestrzeni roboczej: konfigurowanie lokalizacji, działów, typów urlopów, polityk, świąt i użytkowników.
• Niestandardowe: samodzielnie wybierasz każde uprawnienie.

Każde uprawnienie można ustawić na Brak dostępu, Odczyt lub Odczyt i zapis. Zatwierdzanie i odrzucanie wniosków, wyświetlanie ukrytych nazw typów urlopów oraz działanie w imieniu innych użytkowników to osobne pola wyboru, więc włączaj je tylko wtedy, gdy Twoje narzędzie ich potrzebuje. Klucz może robić tylko to, na co Ty masz uprawnienia w Vacation Tracker.

Zarządzanie kluczami

Tabela Klucze API zawiera wszystkie klucze w Twojej przestrzeni roboczej wraz z ich właścicielem, uprawnieniami, ostatnim użyciem, datą wygaśnięcia i statusem. Kliknij klucz, aby otworzyć jego szczegóły, gdzie możesz:

• Sprawdzić wykorzystanie w tym miesiącu oraz edytować nazwę i uprawnienia klucza.
• Przejrzeć Ostatnią aktywność, czyli listę wszystkich żądań, które zmieniły dane.
• Kliknąć Wymień klucz, aby otrzymać nowy klucz z tą samą nazwą i uprawnieniami. Wybierz, czy stary klucz ma działać jeszcze przez 24 godziny (zalecane), przez 7 dni, czy przestać działać od razu.
• Kliknąć Unieważnij, aby trwale wyłączyć klucz.

Wysyłamy Ci e-mail 14 dni przed wygaśnięciem klucza.

Twoje pierwsze żądanie

Bazowy adres URL to https://api.vacationtracker.io/v2. Wysyłaj klucz jako token typu bearer w nagłówku Authorization:

Udane wywołanie zwraca dane w polu data. Listy z kolejnymi stronami zawierają też nextToken, który przekazujesz z powrotem, aby pobrać następną stronę.

Jeśli coś pójdzie nie tak, odpowiedź zawiera obiekt error z kodem, opisem i sposobem rozwiązania. Brakujący lub nieznany klucz zwraca kod 401. Klucz bez uprawnienia wymaganego przez żądanie zwraca kod 403 z INSUFFICIENT_SCOPE.

Jak dodać webhook

1. Na stronie dodatku Open API przejdź do sekcji Webhooki i kliknij Zarządzaj webhookami.
2. Kliknij Dodaj webhook.
3. Wpisz Adres URL endpointu, który ma odbierać zdarzenia. Musi korzystać z protokołu HTTPS.
4. W sekcji Zdarzenia wybierz Decyzje urlopowe, Cała aktywność urlopowa, Pełna synchronizowana kopia lub Niestandardowe, aby samodzielnie wybrać zdarzenia.
5. Kliknij Dodaj webhook.

Otrzymujesz zdarzenia tylko dotyczące danych, które możesz widzieć.

Limity i ograniczenia szybkości

Limity obowiązują dla każdego klucza API:

• Do 30 000 żądań miesięcznie.
• 10 żądań na sekundę, z możliwością chwilowego wzrostu do 50 żądań.

Jeśli Twoja integracja potrzebuje więcej, napisz na adres developers@vacationtracker.io, podając nazwę firmy, integrację i spodziewany ruch.

Najczęstsze pytania