REST API

Automatyzuj autoryzowaną wymianę danych CrewTango

Użyj REST API w formacie JSON, aby połączyć pracowników, projekty, zadania, zarejestrowane okresy pracy i inne obsługiwane zasoby z systemem zewnętrznym.

Dostęp do API i dokumentacji musi być włączony zarówno dla firmy, jak i dla konta użytkownika wykonującego integrację.

JSON format żądań i odpowiedzi
JWT tokeny dostępowe i odświeżające
OpenAPI dokumentacja Swagger dla uprawnionych
POTWIERDZONE ZASOBY API

Buduj integrację wokół zasobów zaimplementowanych w aplikacji

API jest dostępne pod ścieżką /api i korzysta z uwierzytelnienia użytkownika. Dokładny zakres operacji zależy od uprawnień konta i włączonych modułów.

Pracownicy i użytkownicy

Pracuj na kartotekach pracowników i danych kont dostępnych dla uprawnionego użytkownika.

Projekty i zadania

Odczytuj lub aktualizuj obsługiwane dane projektów i zadań używanych do organizacji pracy.

Zarejestrowane okresy pracy i przerwy

Wykorzystuj zarejestrowane okresy pracy i zasoby przerw w raportowaniu albo procesie rozliczeń.

Klienci, lokalizacje i grafiki

Łącz obsługiwane struktury operacyjne z zewnętrznym procesem planowania lub administracji.

Pliki i akceptacje

Korzystaj z dostępnych endpointów plików i akceptacji, jeśli konto integracyjne ma wymagane uprawnienia.

Swagger / OpenAPI

Sprawdzaj aktualną dokumentację endpointów po włączeniu modułu dokumentacji i uprawnienia użytkownika.

DOSTĘP I UTRZYMANIE

Od uwierzytelnienia konta do utrzymywanej integracji

Korzystaj z tego samego modelu ról i uprawnień, który chroni dane w panelu CrewTango.

1

Włączenie API

Uzgodnij zakres oferty indywidualnej i włącz dokumentację API dla firmy oraz uprawnionego użytkownika.

2

Pobranie tokenów JWT

Uwierzytelnij konto użytkownika, aby otrzymać token dostępowy i odświeżający; obsłuż 2FA, jeśli jest włączone.

3

Synchronizacja i logi

Używaj stabilnych ID, waliduj odpowiedzi i zapisuj kontekst potrzebny do diagnozy oraz bezpiecznego ponawiania błędów.

Pytania o REST API

Tak. Aplikacja zawiera dokumentację Swagger/OpenAPI, dostępną po włączeniu modułu dokumentacji dla firmy oraz uprawnienia dostępu API dla użytkownika.

Logowanie API zwraca token dostępowy i odświeżający JWT dla uprawnionego konta użytkownika. Jeśli włączono uwierzytelnianie dwuskładnikowe, proces logowania wymaga też jego weryfikacji.

Nie. Aktualna wersja CrewTango nie udostępnia ogólnego mechanizmu wychodzących webhooków zdarzeń. Integracje powinny korzystać z REST API i — gdy to potrzebne — synchronizacji okresowej.

Ustal zakres API, zanim powstanie integracja

Wypisz zasoby, kierunek wymiany oraz konto, które ma ją wykonywać. Pomożemy zdefiniować bezpieczną pierwszą wersję.

Możesz również otworzyć formularz w nowej karcie lub napisać na [email protected].