API

A FLOWii REST API egy másik megoldás a FLOWii szoftverrel történő kommunikációra. Az API-nak köszönhetően a FLOWii szoftverhez közvetlenül csatlakoztatható céges rendszer vagy akár egy weboldal.

Hol találja az API dokumentációt?

A FLOWii REST API egy másik megoldás a kommunikációra a FLOWii szoftverrel. Az API-nak köszönhetően a FLOWii szoftverhez közvetlenül csatlakoztatható egy céges rendszer vagy akár egy weboldal.

További információ az API-ról közvetlenül a FLOWii beállításokban -> Bővítmények -> API -> API dokumentáció gombra kattintva található.

Megjelenik:

az Ön egyedi API-kulcsa,
API dokumentációs link - http://docs.flowiiapi.apiary.io/
url - api.flowii.com.

Az API jelenleg ezekhez a modulokhoz biztosít hozzáférést:

Partnerek
Feladatok és események
Üzleti esetek
Megbízások
Áruk és szolgáltatások
Számlázás
Pénzügyek
Jelenlét

További információ a FLOWii API működéséről

Szükséges a fiók létrehozása a FLOWii-ban. Fiók létrehozása után egy egyedi API-kulcsot talál a FLOWii-fiókjában.

Bejelentkezési adatok, API kulcs

Ezeket a hitelesítő adatokat, ún. “credentials” (bejelentkezési e-mail, jelszó, API kulcs) szükséges elküldeni az API-ba, amely az ellenőrzést követően visszaküldi Önnek a tokent. A token egy ideiglenes ellenőrző paraméter, amely csak egy bizonyos ideig érvényes (a FLOWii esetében ez néhány perc).

A tokent a POST módszerrel kapja meg a beviteli paraméterek beírásával a következő formában (a YOUR_FLOWII_USER_NAME és YOUR_FLOWII_PASSWORD helyett adja meg bejelentkezési nevét és jelszavát a FLOWii-ba):

grant_type=password&username=YOUR_FLOWII_USER_NAME&password=YOUR_FLOWII_PASSWORD

A kérelem header-ében (fejlécében) adja meg az Api-Key paramétert és az API-kulcs értékét. A tokent például a Postman, az Insomnia és hasonlókon keresztül szerezheti be. Az Insomnia-n keresztül a token megszerzése így néz ki:

- beviteli paraméterek a kérésben (request-ben) (grant_type, username, password):

- a kérelem header-je (fejléce) az Api-Key paraméterrel és API-kulcsával:

A kérelem elküldése után választ kellene kapnia az API-tól az "access_token" paraméterrel (példaválasz):

A token típusa Bearer.

Fontos tudni, hogy az API-tól érkező válasz JSON formátumban van

Ha megszerezte a token-t az API-ból, akkor szükséges az ID user adat (felhasználói azonosító) illetve a cég adat lehúzása a FLOWii-ból, amely alatt fiókot hozott létre a FLOWii-ban. Erre szolgál a "Get company access list" API endpoint

https://flowiiapi.docs.apiary.io/#reference/account/allowed-companies/get-company-access-list.

Megadja a token-t:

- header-be (fejlécbe) beírja az API-kulcsot:

Válaszként kap az API-tól egy JSON-t, amely tartalmazza a „id”user paraméter numerikus értékét. Ezután más API-végpontokat is megadhat ezzel az értékkel.