A FlexiProject REST API-t kínál, amelyen keresztül egy másik rendszer beolvashatja és módosíthatja a szervezet adatait — például BI-jelentés adatokkal való ellátására, projektek ERP-rendszerrel való szinkronizálására vagy ismétlődő feladatok automatizálására. A végpontok teljes leírása a developers.flexi-project.com oldalon található.

Az API hívásához személyes hozzáférési token (API-token) szükséges. Ezt Ön hozza létre a profiljában, az API fülön, és az Ön jogosultságaival működik: az API pontosan azokat az adatokat mutatja, amelyeket az alkalmazásban Ön is lát, többet nem.

Személyes hozzáférési token

Ki hozhat létre tokent

Tokent a saját fiókjához a Teljes licenccel rendelkező felhasználó (lásd: Felhasználói licencek) és a rendszeradminisztrátor hozhat létre; az API fül csak nekik látható. Adminisztrátori jogosultságra nincs szükség. A token a tulajdonosa jogosultságait hordozza, ezért ugyanazokhoz a projektekhez és mezőkhöz fér hozzá, amelyeket a tulajdonos az alkalmazásban lát. Két különböző szerepkörű személy ugyanarra a kérésre eltérő eredményt kap.

A token működése megszűnik, ha a fiókot inaktiválják, eltávolítják a szervezetből vagy zárolják, ezért a tokeneket nem kell takarítani, amikor valaki távozik.

Token létrehozása

1. Nyissa meg az avatar menüjét, válassza a Felhasználói profil pontot, és lépjen az API fülre (lásd: Felhasználói profil).
2. Kattintson az Új token gombra.
3. Töltse ki a Név mezőt — legfeljebb 100 karakter hosszan. A névnek jeleznie kell, melyik integrációt szolgálja a token, mert később csak ebből lehet megkülönböztetni a tokeneket.
4. Állítsa be a Lejárati dátum mezőt. A legkorábbi érték a holnapi nap, a legkésőbbi a mai naptól számított 365. nap; a mező 30 napra előre kitöltve nyílik meg. A token a kiválasztott nap végén jár le.
5. Kattintson a Token létrehozása gombra.

Másolja ki azonnal a tokent

A token teljes értékét csak egyszer mutatja az ablak, amelynek címe A személyes hozzáférési token létrejött, ezzel a figyelmeztetéssel: Másolja ki a tokent, és őrizze biztonságos helyen — az ablak bezárása után már nem lesz lehetőség a megtekintésére. A Másolás gomb a vágólapra másolja az értéket, Ön pedig közvetlenül beilleszti abba a rendszerbe, amely használni fogja. Az ablak bezárása után az értéket senki sem tudja visszaállítani — sem Ön, sem az adminisztrátor, sem a támogatás. Ha elveszít egy tokent, törölje, és hozzon létre újat.

A tokenek listája

Az API fül a tokeneket a Név, Token, Létrehozva és Lejár oszlopokban sorolja fel. A Token oszlop csak az érték első karaktereit mutatja — ez elég ahhoz, hogy egy tokent összepárosítson az integrációban elmentett tokennel.

A Lejár oszlop előre figyelmeztet: a hét napon belül lejáró token mellett címke mutatja a hátralévő napok számát, a ma lejáró token mellett a ma lejár felirat látható, a lejárt token mellett pedig a lejárt. A lejárt token a törlésig a listán marad, de már semmit sem hitelesít.

Egyszerre legfeljebb tíz aktív token lehet. A korlát elérése után az alkalmazás megtagadja újabb létrehozását, ezzel az üzenettel: Már 10 aktív személyes hozzáférési tokenje van. Új token létrehozásához töröljön egy nem használt tokent. A lejárt tokenek nem számítanak bele a korlátba.

Token törlése

A token sorában lévő kuka ikon megerősítés után törli a tokent. Az alkalmazás figyelmeztet, hogy az ezt használó integrációk azonnal leállnak — és valóban, a következő kérésüknél le is állnak. A törlés nem vonható vissza; a token cseréje mindig új tokent, új értékkel jelent.

A token használata

Az API-tokent nem kell minden kéréssel elküldeni: egyszer cserélje át hozzáférési tokenre, és attól kezdve azt használja.

Küldjön egy POST kérést a /api/user/token/personal címre az e-mail-címével és a token értékével:

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

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

A válasz tartalmazza az access_token értékét, annak típusát, annak a szervezetnek az azonosítóját, amelyhez a token tartozik, valamint az érvényességi idő hosszát másodpercekben. A hozzáférési tokent a további hívások Authorization fejlécében küldje el, és lejáratakor ismételje meg a cserét.

Az e-mail-címnek a tokent létrehozó fiókhoz kell tartoznia, és a token maga dönti el, melyik szervezetbe jut be — ha több szervezetben dolgozik, mindegyikben hozzon létre külön tokent.

Az ismételt sikertelen próbálkozások korlátozottak: ugyanarra az e-mail-címre tíz sikertelen próbálkozás után a további próbálkozásokat tizenöt percre elutasítják. Ha egy integráció hirtelen tömegesen kap elutasítást, ellenőrizze az elmentett értéket ahelyett, hogy ciklusban próbálkozna újra.

A tokencsere akkor is működik, ha a jelszavas bejelentkezés ki van kapcsolva, mert nem személy jelentkezik be (lásd: Bejelentkezési módok).