APIの仕組み

APIコールのタイプ

GET、POST、DELETEAPIコールタイプは、ESET PROTECT On-PremAPIで利用できます。

•GETコールには入力パラメーターが含まれており(本文はありません)、URL内で直接データを送ります。リクエストコールは変更できません。実行だけできます。

•POSTコールにはリクエスト本文が必要であり、各POSTコールごとにパラメーターがドキュメント化されています。

•ページネーション(page_size)が含まれるAPIリクエストでは、既定のページサイズは100、最大サイズは10000です。

各コールは以下で構成されています。

•コールタイプ

•要求URL

•リクエストヘッダー(認証トークンで構成されていることもあります)

•リクエスト本文(特にPOSTコールの場合、データを含みます)

サーバーの応答構造

各APIコールはRESTサーバーから応答を受け取ります。応答は、サーバーの応答コードとJSONデータ形式の応答で構成されています。

応答は以下で構成されています。

•サーバーコード

•応答本文

•応答ヘッダー

APIコールの例

GET

ポリシーを表示します(Policy_UUIDはWebコンソールから取得されます。):

POST

デバイスを特定の静的グループに移動します(URLにコンピューターIDが含まれます。):