Jak funguje API
Typy volání API
V ESET PROTECT On-Prem API jsou k dispozici typy volání GET, POST a DELETE API.
•Volání typu GET neobsahují žádné vstupní parametry (nemají tělo) a odesílají data přímo v URL. Volání požadavku nelze upravit, pouze provést.
•Volání typu POST vyžadují tělo požadavku – pro každé volání typu POST existuje dokumentace.
•V požadavcích API, které obsahují stránkování (page_size), je výchozí velikost stránky 100 a maximální velikost je 10000.
Každé volání se skládá z:
•Typu volání
•URL požadavku
•Hlavičky požadavku (může obsahovat ověřovací token)
•Těla požadavku (obsahuje data, zejména u volání typu POST)
Struktura odpovědi serveru
Každé volání API obdrží odpověď od serveru REST. Odpověď se skládá z kódu odpovědi serveru a odpovědi naformátované jako data ve formátu JSON.
Odpověď se skládá z:
•Kódu serveru
•Těla odpovědi
•Hlavičky odpovědi
Příklady volání API
GET
Zobrazení politiky (Politika Policy_UUID je převzatá z webové konzole.):
Způsob |
GET |
Funkce |
|
URL |
https://protect_server:9443/v2/policies/Policy_UUID |
Tělo |
|
Autorizace |
Bearer token |
POST
Přesunutí zařízení do konkrétní statické skupiny (ID zařízení je součástí URL adresy):
Způsob |
POST |
Funkce |
|
URL |
https://protect_server:9443/v1/devices/a13f7d4c-e689-47cb-939d-91b9c9664a57:move |
Tělo |
{ "newParentUuid": "be3d7451-e625-47fb-8f29-f98d61b40db1" } |
Autorizace |
Bearer token |