Dokumentacja API
API REST Flowtly — 927 punktów końcowych w 192 zasobach, generowane z aktualnego schematu OpenAPI.
Ta dokumentacja jest generowana ze schematu API. Opisy pól oraz wszelkie teksty, które nie zostały jeszcze przetłumaczone, są wyświetlane po angielsku.
Zanim zaczniesz budować
Uwierzytelnianie
Wyślij osobisty token dostępu w nagłówku Authorization: Bearer <token>. Utworzysz go we Flowtly na stronie Bezpieczeństwo w swoim profilu. Token działa z Twoimi uprawnieniami, jest ważny 365 dni, o ile nie wybierzesz inaczej (maksymalnie 730), i można go w każdej chwili unieważnić w tym samym miejscu.
Nagłówek organizacji
Każde żądanie niesie też nagłówek instance z identyfikatorem organizacji, w której działasz. Bez niego API odrzuca żądanie.
Żądania i odpowiedzi
Odpowiedzi mają format JSON-LD (application/ld+json) lub zwykły JSON (application/json). Aktualizacje używają PATCH z application/merge-patch+json. Kolekcje są stronicowane za pomocą page i itemsPerPage, po najwyżej 500 pozycji na stronę.
Wersjonowanie
API nie ma wersji w ścieżkach ani w nagłówkach: zasoby leżą w katalogu głównym, na przykład https://api.flowtly.eu/projects. Dokument OpenAPI 3.1 jest opublikowany pod adresem https://api.flowtly.eu/docs.json.
Limity żądań
Żądania podlegają limitom. Żądania zapisu (POST, PUT, PATCH, DELETE) są liczone dla organizacji w oknie pięciominutowym, przy wyższym limicie, gdy organizacja jest zweryfikowana lub ma subskrypcję. Po przekroczeniu limitu API odpowiada 429 Too Many Requests z nagłówkiem Retry-After, który podaje liczbę sekund do odczekania. Limity mogą się zmieniać, więc czytaj Retry-After zamiast wpisywać liczbę na stałe.
Wycofywanie
Endpoint lub pole, które jest wycofywane, jest oznaczone jako deprecated w dokumencie OpenAPI. API nie wysyła nagłówków o wycofaniu, więc przy aktualizacji integracji sprawdź ten dokument.
Testowanie integracji
Nie ma osobnego środowiska sandbox. Przetestuj integrację w próbnej przestrzeni roboczej na danych przykładowych, zanim podłączysz dane produkcyjne. Dopóki organizacja nie jest zweryfikowana ani nie ma subskrypcji, wersja próbna działa z niższym limitem zapisu i nie wysyła wiadomości e-mail.
Co się zmieniło
Zmiany w API ogłaszamy w informacjach o wersjach, razem z resztą produktu.
Przeczytaj informacje o wersjachProjekty i realizacja
97Projekty, zadania, członkowie, stawki i alokacje — automatyzuj realizację i synchronizuj dane projektów.
Zasoby i obłożenie
11Alokacje, bench, okno harmonogramu i dane rzeczywiste — planuj, kto nad czym pracuje, i odczytuj, co faktycznie zrobiono.
Faktury i płatności
49Faktury, pozycje, płatności, przypomnienia i e-faktury (KSeF) — automatyzuj fakturowanie od początku do końca.
Budżety i wydatki
159Budżety, transakcje, koszty, podatki i konta bankowe — śledź wydatki i automatycznie uzgadniaj płatności.
CRM — leady i szanse sprzedaży
78Leady, szanse sprzedaży, pipeline'y i etapy — prowadź lejek sprzedaży z własnych systemów.
Klienci i kontrahenci
34Klienci, kontakty i kontrahenci — utrzymuj CRM i Flowtly w synchronizacji.
HR i pracownicy
87Pracownicy, działy, stanowiska, benefity i odpowiedzialności — automatyzuj przepływy danych HR.
Wydajność i oceny
31Cykle ocen, szablony, pytania i sesje — przeprowadzaj oceny pracownicze programistycznie.
Czas i frekwencja
67Czas pracy, urlopy, harmonogramy i święta — rejestruj i odczytuj frekwencję programowo.
Rekrutacja i ATS
40Kandydaci, zadania rekrutacyjne, rozmowy kwalifikacyjne i planowanie terminów — połącz swój system ATS.
Nieruchomości i majątek
50Nieruchomości, rezerwacje, zasoby, liczniki i odczyty — zarządzaj danymi nieruchomości przez API.
Umowy i zgodność
48Umowy, kontrakty, załączniki i harmonogramy płatności — automatyzuj procesy umowne.
Dokumenty i podpisy
20Dokumenty, przechowywanie i żądania podpisu elektronicznego — przesyłaj, porządkuj i podpisuj pliki.
Dostosowanie i tagi
62Atrybuty, zestawy atrybutów, reguły i tagi — rozszerzaj obiekty Flowtly o własne pola.
Organizacja i konfiguracja
48Organizacja, lokalizacje, użytkownicy, integracje i subskrypcja — konfiguruj przestrzeń roboczą.
Użytkownicy i dostęp
16Użytkownicy i grupy uprawnień — zarządzaj tym, kto co widzi i może robić.
Webhooks i audyt
14Webhooks i logi audytu — reaguj na zdarzenia i śledź zmiany.
Eksporty księgowe
16Eksporty do Wapro, Optima, Enova, Symfonia, MT940 i SEPA — przekaż dane swojej księgowości.
Serwer MCP
Połącz narzędzia AI z Flowtly poprzez Model Context Protocol na mcp.flowtly.eu.