APIの使用例

ログイン後、エージェント一覧から対象となるエージェントの詳細情報を取得する例です。

1. APIキーを取得するAPIを呼び出します。

2. エージェントの一覧情報を取得するAPIを呼び出します。

3. 取得したエージェントIDを利用し、詳細情報を取得するAPIを呼び出します。

(1) APIキー取得(/api/v1/login)

1. ユーザー名とパスワードをJSON形式でセットして、APIに渡します。

2. Managerへのログインが実行され、JSON形式でAPIキーが返されます。

curlコマンドの実行イメージ (Linuxの場合)
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             -d '{  "password": "admin",  "userName": "admin"}'
             'http://localhost:8765/api/v1/login'
curlコマンドの実行イメージ (Windowsの場合)
curl.exe -X POST --header "Content-Type: application/json"
                 --header "Accept: application/json"
　                -d "{\"password\": \"admin\", \"userName\": \"admin\"}"
                 "http://localhost:8765/api/v1/login"
返却されるJSONデータイメージ
{
  "userId":"12abc3d4-5a67-89ab-ab1a-1234a5b6cd78",
  "expiresOn":1506612812802,
  "apiKey":"ab123456-abc1-1a2b-1a23-1a2345b6789c",
  "clientSecret":"ab654321-abc1-1a2b-1a23-1a2345b6789c"
}

(2) エージェント一覧取得(/api/v1/agents)

1. APIキーをリクエストヘッダーにセットします。

2. ページのインデックスとサイズをクエリ形式でセットして、エージェント一覧取得APIに渡します。

3. JSON形式でエージェントの一覧情報が返されます。

curlコマンドの実行イメージ (Linuxの場合)
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:ab123456-abc1-1a2b-1a23-1a2345b6789c'
            'http://localhost:8765/api/v1/agents?sort=+name&page=0&size=100'
curlコマンドの実行イメージ (Windowsの場合)
curl.exe -X GET --header "Accept: application/json"
                --header "X-API-KEY:ab123456-abc1-1a2b-1a23-1a2345b6789c"
                "http://localhost:8765/api/v1/agents?sort=+name&page=0&size=10"
返却されるJSONデータイメージ
{
  "content": [
  {
    "activationKey": "ab123456-abc1-1a2b-1a23-1a2345b6789c",
    "afterModuleUpdated": false,
    "agentId": "1a2b3456-7890-1a23-a123-1abc2a345b6c",
    "agentVersion": 11,
    （以下略）

(3) エージェント詳細取得(/api/v1/agents/agentId)

1. APIキーをリクエストヘッダーにセットします。

2. エージェントIDをパス形式でセットして、エージェント詳細取得APIに渡します。

3. JSON形式でエージェントの詳細情報が返されます。

curlコマンドの実行イメージ (Linuxの場合)
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:ab123456-abc1-1a2b-1a23-1a2345b6789c'
            'http://localhost:8765/api/v1/agents/1a2b3456-7890-1a23-a123-1abc2a345b6c'
curlコマンドの実行イメージ (Windowsの場合)
curl.exe -X GET --header "Accept: application/json"
            　　　　--header "X-API-KEY:ab123456-abc1-1a2b-1a23-1a2345b6789c"
                "http://localhost:8765/api/v1/agents/1a2b3456-7890-1a23-a123-1abc2a345b6c"
返却されるJSONデータイメージ
{
  "activationKey": "ab123456-abc1-1a2b-1a23-1a2345b6789c",
  "afterModuleUpdated": false,
  "agentId": "1a2b3456-7890-1a23-a123-1abc2a345b6c",
  "agentVersion": 11,
  "agentVersionSyncronized": false,
  "basicSettings": {
  "autoResendingRetryCount": 60,
  "autoResendingRetryInterval": 60,
  "connectionRetryCount": 8640,
  （以下略）