FlexiProject nabízí rozhraní REST API, jehož prostřednictvím může jiný systém číst a měnit data organizace — dodávat data do reportu BI, synchronizovat projekty s ERP nebo automatizovat opakující se činnost. Úplný popis koncových bodů najdete na developers.flexi-project.com.

K volání API potřebujete osobní přístupový token (token API). Vytvoříte si ho sami ve svém profilu, na záložce API, a pracuje s vašimi oprávněními: API ukazuje přesně ta data, která vidíte v aplikaci, a nic víc.

Osobní přístupový token

Kdo může token vytvořit

Token pro svůj vlastní účet vytváří uživatel s licencí Úplná (viz Licence) a správce systému; záložka API je viditelná pouze pro ně. Oprávnění správce není potřeba. Token nese oprávnění svého majitele, takže se dostane ke stejným projektům a polím, která majitel vidí v aplikaci. Dva lidé s různými rolemi dostanou ze stejného požadavku různé výsledky.

Token přestane fungovat, jakmile je účet deaktivován, odebrán z organizace nebo zablokován, takže tokeny nemusíte po odchodu osoby uklízet.

Vytvoření tokenu

1. Otevřete nabídku avataru, zvolte Profil uživatele a přejděte na záložku API (viz Profil uživatele).
2. Klikněte na Nový token.
3. Zadejte Název — nejvýše 100 znaků. Název by měl říkat, kterou integraci token obsluhuje, protože jen podle něj později své tokeny rozlišíte.
4. Nastavte Datum platnosti. Nejdříve je to zítřek, nejpozději 365 dní od dneška a pole se otevře s hodnotou 30 dní. Token vyprší na konci zvoleného dne.
5. Klikněte na Vytvořit token.

Zkopírujte token hned

Okno Osobní přístupový token byl vytvořen zobrazí úplnou hodnotu pouze jednou, s upozorněním: Zkopírujte token a uložte ho na bezpečném místě — po zavření tohoto okna už ho nebude možné znovu zobrazit. Tlačítko Kopírovat zkopíruje hodnotu do schránky a vy ji vložíte přímo do systému, který ji bude používat. Po zavření okna už hodnotu nikdo nezíská — ani vy, ani správce, ani podpora. Pokud token ztratíte, odstraňte ho a vytvořte nový.

Seznam tokenů

Záložka API zobrazuje vaše tokeny ve sloupcích Název, Token, Vytvořeno a Vyprší. Sloupec Token ukazuje jen prvních několik znaků hodnoty — stačí k tomu, abyste token přiřadili k tokenu uloženému v integraci.

Sloupec Vyprší varuje s předstihem: token, jehož platnost skončí do sedmi dnů, nese štítek s počtem zbývajících dnů, token vypršející dnes ukazuje vyprší dnes a token s prošlou platností vypršel. Prošlý token zůstává v seznamu, dokud ho neodstraníte, ale už nic neověřuje.

Najednou můžete mít nejvýše deset aktivních tokenů. Po dosažení limitu aplikace vytvoření dalšího odmítne se zprávou Máte již 10 aktivních osobních přístupových tokenů. Pro vytvoření nového odstraňte nepoužívaný token. Prošlé tokeny se do limitu nepočítají.

Odstranění tokenu

Ikona koše v řádku tokenu odstraní token po potvrzení. Aplikace upozorní, že integrace, které ho používají, přestanou okamžitě fungovat — a skutečně přestanou, a to při svém dalším požadavku. Odstranění nelze vrátit; náhrada tokenu vždy znamená nový token s novou hodnotou.

Použití tokenu

Token API se neposílá s každým požadavkem. Jednou ho vyměníte za přístupový token a ten pak používáte dál.

Odešlete požadavek POST na /api/user/token/personal se svou e-mailovou adresou a hodnotou tokenu:

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

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

Odpověď obsahuje access_token, jeho typ, identifikátor organizace, do které token patří, a počet sekund, po které platí. Přístupový token posílejte v hlavičce Authorization dalších volání a po jeho vypršení výměnu zopakujte.

E-mailová adresa musí patřit k účtu, který token vytvořil, a o tom, do které organizace se dostanete, rozhoduje samotný token — pokud pracujete ve více organizacích, vytvořte v každé samostatný token.

Opakované neúspěšné pokusy jsou omezeny: po deseti neúspěšných pokusech pro stejnou e-mailovou adresu se další pokusy po dobu patnácti minut odmítají. Pokud integrace najednou začne dostávat hromadná odmítnutí, zkontrolujte uloženou hodnotu místo opakování ve smyčce.

Výměna tokenu API funguje i při vypnutém přihlašování heslem, protože se nepřihlašuje člověk (viz Metody přihlášení).