API i token API

FlexiProject udostępnia API REST, przez które możesz odczytywać i zmieniać dane swojej organizacji z innego systemu — żeby zasilić raport BI, zsynchronizować projekty z ERP albo zautomatyzować powtarzalną czynność. Pełny opis punktów końcowych znajdziesz na developers.flexi-project.com.

Do wywołania API potrzebujesz tokena API. Tworzysz go samodzielnie w profilu użytkownika i działa on z Twoimi uprawnieniami: API pokaże dokładnie te dane, które widzisz w aplikacji, i nic ponad to.

Token API

Kto może utworzyć token

Każdy użytkownik, dla swojego konta — nie potrzeba do tego uprawnień administratora. Token niesie Twoje uprawnienia, więc sięga po te same projekty i te same pola, które widzisz w aplikacji. Dwie osoby o różnych rolach dostaną z tego samego zapytania różne wyniki.

Token przestaje działać w chwili, gdy Twoje konto zostanie dezaktywowane, usunięte z organizacji albo zablokowane — nie musisz więc sprzątać tokenów, gdy ktoś odchodzi z firmy.

Tworzenie tokenu

1. Kliknij swój awatar, wejdź w Profil użytkownika, a następnie w zakładkę API.
2. Kliknij Nowy token.
3. Podaj Nazwę — do 100 znaków. Wpisz coś, co mówi, jakiej integracji token służy; nazwa to jedyny sposób, żeby później odróżnić swoje tokeny.
4. Ustaw Datę ważności. Najwcześniejsza to jutro, najpóźniejsza 365 dni od dziś, a pole otwiera się na 30 dniach. Token wygasa z końcem wybranego dnia.
5. Kliknij Utwórz token.

Skopiuj token od razu

Okno Osobisty token dostępu został utworzony pokazuje pełną wartość jeden raz, z ostrzeżeniem: Skopiuj token i przechowaj go w bezpiecznym miejscu — po zamknięciu tego okna nie będzie już możliwości jego odczytania.

Użyj przycisku Kopiuj i wklej wartość wprost do systemu, który będzie z niej korzystał. Po zamknięciu okna wartości nie odzyska nikt — ani Ty, ani administrator, ani wsparcie. Jeśli ją zgubisz, usuń token i utwórz nowy.

Lista tokenów

Zakładka API wypisuje Twoje tokeny w czterech kolumnach: Nazwa, Token, Utworzono i Wygasa. Kolumna Token pokazuje tylko początkowe znaki wartości — tyle, żeby dopasować token do tego zapisanego w integracji.

Kolumna Wygasa ostrzega z wyprzedzeniem: token wygasający w ciągu siedmiu dni dostaje znacznik z liczbą pozostałych dni, wygasający dziś — wygasa dziś, a przeterminowany — czerwone wygasł. Token po terminie zostaje na liście, dopóki go nie usuniesz, ale niczego już nie uwierzytelni.

Możesz mieć jednocześnie do dziesięciu aktywnych tokenów. Po osiągnięciu limitu aplikacja odmówi utworzenia kolejnego komunikatem Masz już 10 aktywnych osobistych tokenów dostępu. Usuń nieużywany token, aby utworzyć nowy. Tokeny wygasłe nie wliczają się do limitu.

Usuwanie tokenu

Użyj ikony kosza w wierszu tokenu. Aplikacja ostrzega, że Integracje, które go używają, przestaną działać natychmiast — i faktycznie przestaną, przy najbliższym żądaniu. Usunięcia nie da się cofnąć; zastąpienie tokenu to zawsze nowy token o nowej wartości.

Jak używać tokenu

Tokenu API nie wysyła się przy każdym żądaniu. Wymieniasz go raz na token dostępowy i dalej posługujesz się tym tokenem dostępowym.

Wyślij POST na /api/user/token/personal ze swoim adresem e-mail i wartością tokenu:

POST /api/user/token/personal
Content-Type: application/json

{
  "email": "anna.kowalska@example.com",
  "token": "fpat_…"
}

W odpowiedzi dostaniesz access_token, jego typ, identyfikator organizacji, do której token należy, oraz liczbę sekund jego ważności. Token dostępowy wysyłaj w nagłówku Authorization kolejnych wywołań, a po jego wygaśnięciu powtórz wymianę.

Adres e-mail musi należeć do konta, które utworzyło token, a sam token decyduje o tym, do której organizacji trafisz — jeśli pracujesz w więcej niż jednej, utwórz osobny token w każdej z nich.

Powtarzane nieudane próby są ograniczane: po dziesięciu nieudanych próbach dla tego samego adresu e-mail kolejne są odrzucane przez piętnaście minut. Jeśli Twoja integracja zaczyna masowo dostawać odmowy, sprawdź zapisaną wartość, zamiast ponawiać w pętli.