API és API-token

A FlexiProject REST API-t kínál, amelyen keresztül egy másik rendszer beolvashatja és módosíthatja a szervezet adatait. Ez lehetővé teszi például egy BI-jelentés adatokkal való ellátását, a projektek ERP-rendszerrel való szinkronizálását vagy egy ismétlődő feladat automatizálását. 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. A tokent Ön hozza létre a profiljában, az API fülön.

A token a tulajdonosa jogosultságaival működik. Az API pontosan azokat az adatokat adja vissza, amelyeket a tulajdonos az alkalmazásban lát, többet nem. Két különböző szerepkörű személy ezért ugyanarra a kérésre eltérő eredményt kap.

Személyes hozzáférési token

Ki hozhat létre tokent

A saját fiókjához tartozó tokent a Teljes licenccel rendelkező felhasználó hozhatja létre (lásd: Felhasználói licencek). Az API fül csak az ilyen felhasználók számára látható.

Fontos: A token hozzáférési tokenre cserélése nem sikerül, ha a fiókot inaktiválták, eltávolították a szervezetből vagy zárolták, illetve ha a felhasználónak már nincs Teljes licence.

Token létrehozása

  1. Nyissa meg az avatar menüt (az avatar ikon a képernyő jobb felső sarkában), válassza a Felhasználói profil lehetőséget, és lépjen az API fülre (lásd: Információ fül). Megjelenik a tokenek listája.
  2. Kattintson az Új token gombra. Megnyílik az Új személyes hozzáférési token ablak.
  3. A Név mezőben adjon meg egy nevet (legfeljebb 100 karakter). A névnek jeleznie kell, melyik integrációban használja a tokent, mert később csak ebből lehet megkülönböztetni a tokeneket.
  4. A Lejárati dátum mezőben állítson be egy dátumot. A token a kiválasztott nap végén jár le.
  5. Kattintson a Token létrehozása gombra. A FlexiProject létrehozza a tokent, és megjelenít egy ablakot az értékével.

A Lejárati dátum mező értékhatárai:

  • A legkorábbi dátum a holnapi nap.
  • A legkésőbbi dátum a mai naptól számított 365. nap.
  • Alapértelmezés szerint 30 nap van beállítva.

Avatar menu with User profile and the API tab in the user profile

Másolja ki azonnal a tokent

Az A személyes hozzáférési token létrejött ablak a token teljes értékét csak egyszer mutatja, 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.

Figyelem: Az ablak bezárása után az értéket senki sem tudja visszaállítani: sem a felhasználó, sem az adminisztrátor, sem a támogatás. Az elveszett tokent törölni kell, és újat létrehozni.

A tokenek listája

API tab in the user profile listing two personal access tokens

Az API fül a felhasználó tokenjeit a Név, Token, Létrehozva és Lejár oszlopban sorolja fel. A Token oszlop csak az érték első karaktereit mutatja, ami 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 címke látható.
  • A lejárt token mellett a lejárt címke látható.

A lejárt token a törlésig a listán marad, de már semmit sem hitelesít.

Fontos: Egyszerre legfeljebb tíz aktív tokenje lehet. A lejárt tokenek nem számítanak bele a korlátba.

A korlát elérése után az Új token gomb inaktív, és az eszköztippje ezt mondja: 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.

Token törlése

A token törléséhez kattintson a sorában lévő kuka ikonra (a sor fölé víve az egérmutatót jelenik meg), és erősítse meg. A FlexiProject törli a tokent.

Figyelem: A törlés nem vonható vissza. A törölt token már nem cserélhető hozzáférési tokenre, az integrációnak pedig új, más értékű tokent kell kapnia. A korábban kiadott hozzáférési token az érvényessége végéig (60 percig) működik.

A token használata

Fontos: Az API-tokent nem küldik el minden kéréssel. Egyszer hozzáférési tokenre cserélik, és attól kezdve azt használják.

A token cseréjéhez küldjön egy POST kérést a /api/users/token/personal címre az e-mail-címmel és a token értékével:

POST /api/users/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 (token_type), annak a szervezetnek az azonosítóját, amelyhez a token tartozik (selectedTenantId), valamint a hozzáférési token érvényességi idejét percekben (expires).

A hozzáférési tokent a további hívások Authorization fejlécében küldje el. Lejáratakor ismételje meg a cserét.

Az e-mail-címnek a tokent létrehozó fiókhoz kell tartoznia. A token maga dönti el, melyik szervezetbe jut be, ezért ha több szervezetben dolgozik, mindegyikben külön tokenre van szüksége.

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.

Az API-token cseréje 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).