API

FLOWii REST API predstavuje ďalší spôsob ako komunikovať s FLOWii softvérom.

Kde nájdem API dokumentáciu

FLOWii REST API predstavuje ďalší spôsob ako komunikovať s FLOWii softvérom. Vďaka API je možné prepojiť firemný systém alebo webovú stránku priamo so softvérom FLOWii.

Bližšie informácie o API nájdete priamo vo vašich FLOWii nastaveniach -> Rozšírenia -> API -> Nové FLOWii REST API.

Zobrazí sa:

API momentálne ponúka prístup k evidencii:

Bližšie informácie k fungovaniu FLOWii API

1. Založenie účtu vo FLOWii - postup. Po založení účtu nájdete vo vašom FLOWii konte jedinečný API kľúč.

2. Prihlasovacie údaje, API kľúč

Tieto credentials (prihlasovací email, heslo, API kľúč) potrebujete poslať do API, ktoré vám po overení vráti token. Token je dočasný verifikačný parameter, ktorý platí len určitý čas (pri FLOWii je to niekoľko minút).

Token sa získava metódou POST, a to tak, že vstupné parametre zadáte v nasledujúcom tvare(namiesto YOUR_FLOWII_USER_NAME a YOUR_FLOWII_PASSWORD zadáte váš login a heslo do FLOWii):

grant_type=password&username=YOUR_FLOWII_USER_NAME&password=YOUR_FLOWII_PASSWORD

Do headeru tohto requestu zadáte parameter Api-Key a hodnotu vášho API kľúča. Získanie tokenu môžete robiť napríklad cez Postman, Insomnia a podobne. V Insomnii získanie tokenu vyzerá napríklad takto:

- vstupné parametre v tele requestu (grant_type, username, password):

- header requestu s parametrom Api-Key a vášho API kľúča:

Po odoslaní tohto requestu by ste mali z API dostať odpoveď s parametrom "access_token" (príklad odpovede):

Typ tokenu je Bearer.

Dôležité je vediet, že odpoveď z API je v JSON formáte.

Ak máte token z API, tak potom potrebujete z FLOWii vytiahnuť ID usera, resp. firmy, pod ktorou máte vytvorený účet vo FLOWii. Na to slúži API endpoint "Get company access list" https://flowiiapi.docs.apiary.io/#reference/account/allowed-companies/get-company-access-list

- zadáte token:

- do headeru zadáte váš API kľúč:

Ako odpoveď z API dostanete JSON, ktorý bude obsahovať číselnú hodnotu parametra "id" usera. S touto hodnotou potom môžete volať ďalšie API endpointy.