APIリファレンス

はじめに

本ドキュメントは、IoTアクセス制御エンジンのAPIリファレンスです。
各APIの詳細説明と、リクエストを実行して実際のレスポンスを確認することができる試用機能を提供しています。試用機能の詳細については、「APIの試し方」を参照してください。

APIの概要

IoTアクセス制御エンジンには、下記5つのカテゴリのAPI群が用意されています。これらを利用することで、さまざまなアプリ／サービスを創ることができます。

なお、各APIを実行するには「アクセストークン」が必要です。「APIの試し方」で、アクセストークンの取得～マイユーザ情報取得の手順を例にAPIの実行方法を紹介していますので、ご参考ください。

OAuth2 API

ユーザの認可に関するAPI群です。
APIを実行する際には、リクエストヘッダにアクセストークンを付与する必要があります。

※本API群と、ユーザアカウントの登録[/management/v2/accounts:post]を除く

＜リクエストヘッダ＞

Name Description
Authorization

string　*required

「Bearer」＋「半角スペース」＋「ログイン時に取得したIoTアクセス制御エンジンのアクセストークン」

Management API

ユーザ管理や、リソースおよびリソースへのアクセスコントロールの管理ができるAPI群です。以下が利用可能です。

  • ユーザ管理：ユーザ情報の取得、管理が行えます。
  • ロール管理：共有ユーザに付与可能なロールおよびパーミッションを管理できます。
  • リソース管理：ゲートウェイおよびデバイスを管理できます。また、ニックネームやタグの管理も行えます。
  • PUSH通知：PUSH通知関連の設定を管理できます。また、PUSH通知の開始／停止や履歴の取得も行えます。
  • チーミング管理：異なるゲートウェイに紐づく2つのデバイスを、仮想的に1つのデバイスとみなして動作させる「チーミング」の設定を管理できます。
  • クラウドプラグイン：クラウドプラグイン関連の設定を管理できます。また、情報取得も行えます。
  • Webhook管理：Webhook関連の設定を管理できます。また、情報取得も行えます。
  • イベント管理：Device APIのうちイベント系APIの開始状況を管理できます。

Device API

デバイスの機能にアクセスし、制御やデータ取得を行うためのAPI群です。
APIのパスやパラメータ、レスポンスの内容は、プラグインのAPI設計に依存します。API設計は、[/serviceInformation:get]で取得・確認できます。

このAPIを実行するためには、以下を満たしている必要があります。

  • デバイスに対するプラグインが用意されていること
  • Device Connect Managerおよびプラグインをインストールしたスマートフォンやゲートウェイを用意し、IoTアクセス制御エンジンに接続されていること
  • Management API－リソース管理で、ゲートウェイやデバイスがIoTアクセス制御エンジンに登録されていること
  • クラウドプラグインを利用する場合は、Management API－クラウドプラグインで利用するクラウドプラグインが有効化されていること

　※プラグインが返すProfile情報については、「デバイスプロファイル」の「Hueシリーズ」または「赤外線学習リモコン」を参照してください。

注意

このAPIは一部を除き、デバイスへのアクセスを行うので、他のAPIに比べてレスポンスが遅くなることがあります。
ゲートウェイからのレスポンスがない場合は、約30秒でタイムアウトとなります。 一部のデバイスは複数の経路でデバイスへのアクセスをリトライするため、レスポンスまたはタイムアウトの遅延が生じることがあります。

Archive API

Device APIを実行した結果を記録するかどうかの設定および、記録データの取得を行うAPI群です。

実行結果の記録設定は、デフォルトは「停止中」になっています。
記録が必要な場合は、明示的に記録開始の指示をする必要があります（デバイス毎、または機能（アクション）毎に指示が可能です）。

Visualization API

本機能は2024年4月18日(木) 10:00 をもって停止いたします。再開時期は未定です。

Archive API により記録されたデータの可視化を行うための設定や、設定以前に蓄積されていた過去データを登録するための API 群です。デフォルトは「無効」になっています。

ドキュメント