ツール IoT でのAPIの使用

IoT ツールのドキュメントから直接API呼び出しにアクセスして実行できます。

このタスクについて

IoT ツールAPIには、デバイスからイベントを送信するために使用できるメッセージングAPIやアプリケーションAPIが含まれます。 APIを使用して、デバイス管理、アクション管理、リスク管理などのタスクを管理することができます。 詳細については、 Messaging API および Application API を参照してください。
注： お客様の組織ID（ workspaceId またはテナントIDとも呼ばれる）は、 HTTP APIコールのホスト名に必ず含める必要があります。

手順

  1. ツ IoT ールのAPIドキュメントにアクセスするには、 ツール IoT 内でヘルプ（？）アイコンをクリックし、次に 「API」 をクリックします。
  2. 「APIを表示 」をクリックすると、APIのドキュメントが開きます。
  3. ドキュメントから直接API呼び出しを実行するには、API IoT キーとトークンを生成してください。 複数のAPIキーを生成できます。たとえば、ユーザーごとに1つずつなどです。
    1. ツ IoT ールのメインメニューから、 [アプリ] をクリックします。
    2. 「APIキーを生成 」をクリックします。
    3. 説明と有効期限を指定し、「次へ」 をクリックします。
    4. 指定する API に応じて、 デバイスアプリケーションロールまたは標準アプリケーションロールのいずれかを選択します。 役割の詳細については、「役割ベースのアクセス制御の使用 」を参照してください。
    5. 注 ：認証トークンは復元できません。 新しいトークンを生成するには、APIキーを再度登録する必要があります。
      「キーを生成 」をクリックします。 APIキーとトークンを記録する。
  4. APIを認証する。 API ドキュメントから、 [Authorize] をクリックします。
  5. 「利用可能な認証」 ダイアログで、認証情報を指定します。
    1. Usernameフィールドに、生成したAPIキーを指定します。
    2. パスワードフィールドに、生成したトークンを指定します。
  6. 承認をクリックします。
  7. 利用可能な権限ダイアログを閉じます。 ログアウトをクリックしないでください。
  8. API ドキュメントで、指定する API の「Try it out」 をクリックします。
  9. 「実行」 をクリックします。