14. API

Tento modul je přístupný pouze administrátorům instance a lze k němu přistoupit z postranního panelu vybráním modulu API. Tento modul je přístupný pouze s licencí verze Enterprise.

14.1. API uživatelé

Kromě administrátora instance mají k aplikačním rozhraním přístup pouze explicitně definovaní API uživatelé. Tyto uživatele je možné spravovat v sekci API -> Uživatelé API. Tito uživatelé slouží pouze k přístupu k aplikačním rozhraním a nemají žádná další oprávnění přístupu do systému.

Vytvoření API uživatele

Založení API uživatele je možné kliknutím na zelené tlačítko Přidat uživatele a vyplněním patřičného formuláře.

Parametr	Vyžadován	Popis
Jméno	Ano	Přihlašovací jméno API uživatele. Pro zachování maximální kompatibility s aplikacemi třetích stran doporučujeme volit jednoduchá jména bez diakritiky. Například: apiuser1, api_user_2, …
Aktivní	Ne	Pouze aktivní API uživatelé mohou využívat dostupní aplikační rozhraní.
Popis	Ne	Slouží pro zlepšení orientace v systému.

Po vytvoření uživatele je mu vytvořeno unikátní tajemství, které je možné si zobrazit skrze ikonu zobrazit v seznamu API uživatelů. Toto tajemství slouží jako heslo pro přístup k aplikačním rozhraním.

Editace API uživatele

Editace API uživatele je možná v aktualizačním formuláři, který si může oprávněný uživatel otevřít v seznamu API uživatelů skrze ikonu tří teček.

Aktivace a deaktivace API uživatele

Zda je uživatel aktivní nebo neaktivní, indikuje sloupec Stav ve výpisu API uživatelů. Zároveň, přes toto tlačítko může administrátor přejít do aktivačního/deaktivačního formuláře. Pouze aktivní API uživatelé mohou využívat dostupní API rozhraní.

Resetování tajemství API uživatele

Tajemství API uživatele slouží jako přihlašovací heslo k přístupu k dostupným API rozhraním. Tajemství může administrátor resetovat skrze tlačítko Resetovat.

14.2. Správa API

Risk Flow nabízí jednoduchou správu aplikačních rozhraní, která vypadá následovně.

Přiřazení přístupu API uživatelům

Ke každému API rozhraní je nutné explicitně definovat uživatele, kteří k němu mohou přistupovat. Toto můžete upravit skrze editační formulář po kliknutí na tlačítko Upravit uživatele. K API rozhraní je možné přiřadit žádného či více API uživatelů.

Aktivace a deaktivace API

Aplikační rozhraní je možné aktivovat a deaktivovat skrze aktivační/deaktivační formulář. Pouze k aktivním API rozhraním mohou API uživatele přistupovat.

Otestování API v prohlížeči

Každé aplikační rozhraní je možné otestovat v prohlížeči kliknutím na tlačítko Otestovat API.

Příklad použití API pomocí aplikace Postman

Postman je aplikace sloužící pro testování aplikačních rozhraní jiných systémů. V této části bude demonstrováno propojení API s aplikací třetí strany a zobrazení dostupných dat.

Všechna dostupná aplikační rozhraní jsou popsána v následující kapitole – Dostupná API. Pro demonstraci funkčnosti aplikačního rozhraní bude vytvořen požadavek na vypsání všech uživatelů prvního klienta. Nejprve musíme zjistit ID klienta, pro kterého chceme získat výpis uživatelů. Provedeme tedy požadavek na patřičné aplikační rozhraní s následujícími parametry. Nejprve nastavíme správně autentizační údaje – jméno, heslo a url adresu požadovaného API.

Po odeslání takového požadavku získáme soupis všech evidovaných klientů a informace o jejich uživatelích.

Nyní známe identifikátor klienta z jménem Klient 1 a tuto znalost můžeme využít k dalším požadavkům. Vytvoříme nový požadavek v aplikaci Postman a nastavíme stejné autentizační a autorizační hodnoty jako v předchozím požadavku. V tomto případě přidáme další parametr specifikují vybraného klienta. Využijeme API pro zjištění všech dostupných analýz pro tohoto klienta.

Po odeslání takového požadavku získáme výsledek obsahující seznam dostupných analýz rizik pro tohoto klienta. Jaká API jsou k dispozici a jaké parametry přijímají je popsáno v následující kapitole.

14.3. Dostupná API

Risk Flow poskytuje standardní REST API rozhraní. Je možné využívat následující rozhraní. Některá rozhraní přijímají dodatečné http GET parametry. Červeně označené parametry jsou povinné.

URL adresy jednotlivých aplikačních rozhraní jsou dostupné na https://NAZEV-INSTANCE.riskflow.cz/api/.

Název	Popis	Dodatečné parametry
Uživatelé	Výpis uživatelů Risk Flow.	role Přijímá hodnoty manager, analyst, auditor, client. active Přijímá hodnoty true nebo false. Vrátí aktivní nebo neaktivní uživatele na základě vybrané hodnoty. lang Přijímá hodnoty cs nebo en. Vrátí uživatele s vybraným preferovaným jazyk notifikačních e-mailů.
Klienti	Výpis všech evidovaných klientů.
Uživatelé klienta	Výpis uživatelů vybraného klienta.	client Přijímá ID klienta. Vrátí seznam uživatelů vybraného klienta. active Přijímá hodnoty true nebo false. Vrátí aktivní nebo neaktivní uživatele na základě vybrané hodnoty. lang Přijímá hodnoty cs nebo en. Vrátí uživatele s vybraným preferovaným jazyk notifikačních e-mailů.
Skupiny aktiv	Výpis skupin aktiv vybraného klienta.	client Přijímá ID klienta. Vrátí seznam skupin aktiv vybraného klienta.
Aktiva	Výpis aktiv a skupin pro vybraného klienta.	group Přijímá ID skupiny aktiv. Vrátí seznam aktiv vybraného skupiny. availability Přijímá hodnoty low, medium, high, critical, not-set. Vrátí seznam aktiv dle vybrané hodnoty. integrity Přijímá hodnoty low, medium, high, critical, not-set. Vrátí seznam aktiv dle vybrané hodnoty. confidentiality Přijímá hodnoty low, medium, high, critical, not-set. Vrátí seznam aktiv dle vybrané hodnoty. type Přijímá hodnoty primary, auxiliary. value Přijímá hodnoty 1, 2, 3, 4, 0. Hodnota 0 filtruje aktiva, kterým hodnota ještě nebyla stanovena.
Analýzy rizik	Výpis všech analýz rizik.	client Přijímá ID klienta. Vrátí seznam analýz rizika vybraného klienta. manager E-mail uživatele, který působí u analýzy jako odpovědný manažer. analyst E-mail uživatele, který působí u analýzy jako analytik. status Přijímá hodnoty started, inprogress, finished, waitingforapproval, approved, notapproved, inflow, inflownotapproved, inflowapproved.
Analýza rizik	Detail konkrétní analýzy rizik.	analysis Přijímá ID analýzy rizik. Vrátí detail vybrané analýzy.
Komentáře k analýze rizik	Výpis komentářů pro vybranou analýzu rizik.	analysis Přijímá ID analýzy rizik. Vrátí komentáře vybrané analýzy.
Flows	Výpis všech flow.	client Přijímá ID klienta. Vrátí seznam flows vybraného klienta. manager E-mail uživatele, který působí u flow jako odpovědný manažer. status Přijímá hodnoty started, inprogress, finished, waitingforapproval, approved, notapproved, done, auditdone. type Přijímá hodnoty approval nebo audit a na základně vybraného typu filtruje seznam flows.
Schvalovací flow	Detail schvalovacího flow.	flow Přijímá ID flow. Vrátí detail vybraného flow.
Auditní flow	Detail auditního flow.	flow Přijímá ID flow. Vrátí detail vybraného flow.
Komentáře k flow	Výpis všech komentářů k vybranému low.	flow Přijímá ID flow. Vrátí komentáře vybraného flow.
Všechny aktiva a skupiny klientů	Výpis všech klientů, jejich skupin aktiv a všech patřičných aktiv.	client Přijímá ID klienta. Vrátí seznam skupin aktiv a jejich aktiv pro vybraného klienta.
Záznamy importů	Evidence importů a popisu případných chyb.
Plány zvládání rizik	Výpis plánů zvládání rizik	client Přijímá ID klienta. Vrátí seznam plánů zvládání rizik vybraného klienta. manager E-mail uživatele, který působí u plánu jako odpovědný manažer. analyst E-mail uživatele, který působí u plánu jako analytik. status Přijímá hodnoty started, inprogress, finished, waitingforapproval, approved, notapproved, inflow, inflownotapproved, inflowapproved.
Plán zvládání rizik	Detail plánu zvládání rizik	plan Přijímá ID plánu zvládání rizik. Vrátí detail vybraného plánu.
Komentáře k plánu zvládání rizik	Komentáře ke konkrétnímu plánu zvládání rizik	plan Přijímá ID plánu zvládání rizik. Vrátí komentáře vybraného plánu.