Ako API funguje?

Typy volaní API

Typy volaní GET, POST a DELETE rozhrania API sú dostupné v ESET PROTECT On-Prem API.

•Volania GET neobsahujú žiadne vstupné parametre (nemajú telo) a odosielajú údaje priamo v URL adrese. Volanie požiadavky nie je možné upraviť; dá sa iba vykonať.

•Volania POST vyžadujú telo požiadavky – parametre sú zdokumentované pre každé volanie POST.

•Pri požiadavkách API, ktoré obsahujú stránkovanie (page_size), je predvolená veľkosť stránky 100 a maximálna veľkosť je 10000.

Každé volanie pozostáva z:

•typu volania,

•URL požiadavky,

•hlavičky požiadavky (môže obsahovať autentifikačný token),

•tela požiadavky (obsahuje údaje, najmä pri volaniach POST).

Štruktúra odpovede servera

Každé volanie API prijme odpoveď zo servera REST. Odpoveď pozostáva z kódu odpovede servera a odpovede vo formáte JSON.

Odpoveď obsahuje:

•kód servera,

•telo odpovede,

•hlavičky odpovede.

Príklady volaní API

GET

Zobrazenie politiky (Policy_UUID sa získa z Web Console):

POST

Presun zariadenia do konkrétnej statickej skupiny (ID počítača je súčasťou URL adresy):