Milesight 開発プラットフォームは、システムをサードパーティのアプリケーションと統合するためのアプリケーションプログラミングインターフェース (API) を提供しています。Milesight 開発プラットフォーム API を使用すると、サードパーティのアプリケーションは Milesight 開発プラットフォーム内のリソースにアクセスして管理することができます。これにより、システム間のワークフローの自動化を実現し、独自のアプリケーションのカスタマイズオプションを増やすことができます。

前提条件

API を使用する前に、Milesight 開発プラットフォームでアプリケーションを作成する必要があります。各アプリケーションには、Milesight Open API に接続するための固有の認証情報セットが備わっています。

詳細については、「アプリケーションの概要」をご覧ください。

通信方法

Milesight Development Platform API を使用すると、サードパーティのアプリケーションは、以下の通信方法により、Milesight Development Platform との双方向通信を実装することができます。

• API リクエストおよび API レスポンス

Milesight Development Platform RESTful API により、サードパーティのアプリケーションは、Milesight Development Platform 内のリソースを照会および管理するための API を呼び出すことができます。サードパーティアプリケーションが API リクエストを送信するたびに、Milesight Development Platform はリクエストの結果を示すレスポンスを返します。

• 詳細については、「リクエストの構造」および「レスポンスの結果」を参照してください。

イベントサブスクリプションおよびイベント通知

Milesight Development Platform は、イベント駆動型の通知に Webhook を利用しています。Milesight Development Platform で Webhook を設定すると、デバイスがプラットフォームにデータを報告すると、システムは統合されたサードパーティアプリケーションに通知をプロアクティブに送信します。

詳細については、「イベント通知の概要」を参照してください。

主な機能

Milesight Development Platform API には、2 つの主な機能があります。

• デバイス管理

デフォルトの RPS (リダイレクトおよびプロビジョニングサービス) 設定を使用する場合は、API インターフェースを介して Milesight Development Platform にデバイスを追加し、以下を実現できます。

• Milesight Development Platform にデバイスを追加し、アプリケーションに関連付ける
• デバイスの照会および管理
• デバイスのステータスをリモートで監視
• デバイスサービスをリモートで呼び出す
• 特定のイベントが発生したときにリアルタイムの通知を受信する

• RPS 管理

デバイス RPS (リダイレクトおよびプロビジョニングサービス) にカスタムプロファイルを使用する場合は、API を使用して次のことを実行できます。

• デバイスのプロファイル URL を指定する
• デバイスのプロファイル URL を照会する
• デバイスの RPS レコードを削除する

使用可能な API インターフェースの詳細については、API インターフェースリストをご覧ください。

ワークフロー

1. Milesight Development Platform でアプリケーションを作成して、認証情報を取得します。
2. 認証情報を使用してアクセス トークンを取得します。
3. アクセス トークンを使用して API リクエストを実行します。