Armadillo Twin REST API 利用方法

API の利用設定を行う

Armadillo Twin REST API 有効化

Armadillo Twin REST APIを利用する場合、以下の手順で有効化する必要があります。

画面右上のユーザー名をクリックします。
「アカウント管理」をクリックします。
「アカウント管理」画面にある「API設定」の「APIの利用を有効化する」にチェックを入れ、「保存」をクリックします。
「API設定を有効にしますか？」の確認画面が開いたら、「上記に同意し、API設定を変更する。」のチェックボックスにチェックを入れ、「変更」ボタンをクリックします。

API 利用方法

認可トークンを発行する

Armadillo Twin REST APIを呼び出す場合、Login APIを呼び出し認可トークンを発行する必要があります。

$ curl -X POST -H "Content-Type: application/json" -d '{"username":"armadillo-twin@example.com","password":"Hfew_351"}' "https://api.armadillo-twin.com/login"

{"Authorization":"MzYxGDBmN2UtYTMxYi00MDcxLDz1N2ItNzVhNzEaYjI0ODBlLDE3NDk1MDEwNzF3ODA="}

Armadillo Twin REST API を呼び出す

取得した認可トークンをヘッダーに指定し、以下のようにArmadillo Twin REST APIを呼び出します。

$ curl -X GET -H "Authorization":"MzYxGDBmN2UtYTMxYi00MDcxLDz1N2ItNzVhNzEaYjI0ODBlLDE3NDk1MDEwNzF3ODA=" "https://api.armadillo-twin.com/devices?pageSize=1"

{
  "Item":[
    {
      "deviceId":"00C901234567",
      "modelName":"Armadillo-IoT G4",
      "label":"Device001",
      "groupName":"Factory001",
      "connectionStatus":"ONLINE",
      "softwareVersions":[
        "base_os 3.21.3-at.13",
        "boot 2020.4-at.25"
      ],
      "plan":"BASIC",
      "deviceReady":true,
      "lastHeartbeat":"2025-06-05T17:09:08.000Z",
      "deviceRegistration":"2025-06-01T17:09:08.818Z"
    }
  ],
  "LastEvaluatedKey":"00C901234567"
}

ページネーション

各APIには、一度に取得できるデータの件数が定められています。件数を超えている場合、複数のページに分割してデータを返却します。ページネーションが発生した場合、 APIのレスポンスデータに次のページを取得する際に使用するデータ (LastEvaluatedKey)が含まれます。

 curl -X GET -H "Authorization":"MzYxGDBmN2UtYTMxYi00MDcxLDz1N2ItNzVhNzEaYjI0ODBlLDE3NDk1MDEwNzF3ODA=" "https://api.armadillo-twin.com/devices?pageSize=1&lastEvaluatedKey=00C901234567"

{
  "Item":[
    {
      "deviceId":"00C901234568",
      "modelName":"Armadillo-IoT G4",
      "label":"Device002",
      "groupName":"Factory001",
      "connectionStatus":"ONLINE",
      "softwareVersions":[
        "base_os 3.21.3-at.13",
        "boot 2020.4-at.25"
      ],
      "plan":"LITE",
      "deviceReady":true,
      "lastHeartbeat":"2025-06-05T17:11:03.000Z",
      "deviceRegistration":"2025-06-01T17:09:13.214Z"
    }
  ],
  "LastEvaluatedKey":""
}

エラーメッセージ・ステータスコード

Armadillo Twin REST APIでエラーが発生した際、エラーメッセージを返却します。各APIのエラーメッセージはArmadillo Twin REST API リファレンスをご確認ください。なお、エラーのうち400 Bad Requestと504 Gateway TimeoutはTwinポイントを消費します。