ADI OtoSense REST API

はじめに

ADI OtoSense SMS REST APIは、以下のような幅広い操作とリソースを提供します:

  • スマート・モーター・センサーで強化されたモーターのプロビジョニングを可能にする。
  • 分析出力を含むモーターデータセットにアクセス。
  • 過去の記録を含むモーターアラートの詳細を検索します。

APIへのアクセス

ADI OtoSense SMSのテナントをお持ちの場合、テナントのAPIエンドポイントを経由してADI OtoSense SMS REST APIにアクセスすることができます。エンドポイントはADI OtoSense SMS Web UI の API - エンドポイント画面で確認できます。

ADI OtoSense SMS テナントをお持ちでない場合は、otosenseにアクセスし、プロダクショントライアルテナントにサインアップしてください。

認証

ADI OtoSense SMS REST APIはOAuth v2.0を使用して認証を行います。

アナログ・デバイセズでは、APIユーザーに対して最小権限のアプローチを推奨しています。APIユーザーには、最小レベルの特権を持つロールのみを割り当てるようにしてください。

OAuthによる認証には以下の手順が必要です:

  1. クライアントAPIキーを作成します。
  2. トークンを生成する。
  3. 認証されたリクエストを行う。

クライアントの作成

まずADI OtoSense SMS UI で API キーを作成する必要があります。これを行うには、ADI OtoSense SMSテナントの管理者である必要があります。これは1回限りの操作です。クライアントIDとクライアントシークレットが提供されます。次のステップで必要になりますので、この情報を控えておいてください。クライアントIDとクライアントシークレットは機密情報であるため、適切に保護する必要があります。フロントエンドのシングルページアプリケーションで使用したり、ソースコードにコミットしたり、一般的にアクセスできるようにしたりしないでください。

注:APIキーは、割り当てられたユーザー・ロールによって管理されます。キーで利用可能な操作は、このロールによって決定されます。

ADI OtoSense REST APIのフルバージョンはこちらをご覧ください。