Milesight Development Platform は、イベント駆動型の通知に Webhook を使用しており、デバイスがプラットフォームにデータを報告すると、統合されたサードパーティアプリケーションに通知をプロアクティブかつタイムリーに配信します。このトピックでは、要件、Webhook ワークフロー、サポートされている Webhook イベントなど、Milesight Development Platform Webhook の概要について詳しく説明します。
要件
- サードパーティアプリケーションが Webhook 機能をサポートしていること。
- サードパーティアプリケーションは、HTTPS 要求を処理でき、有効な HTTPS 証明書がインストールされている必要があります。
Webhook ワークフロー
次の図は、Webhook ワークフローを示しています。
Milesight Development Platform から Webhook イベント通知を受信するには、サードパーティアプリケーションから Webhook URL を取得し、Milesight Development Platform で Webhook を設定する必要があります。
デバイスが Milesight Development Platform にデータを報告すると、システムは JSON ペイロードを含む POST リクエストを使用して、報告された詳細を Webhook URI に送信します。
Webhook イベントの種類
各イベントの種類とイベントのトリガーについては、次の表を参照してください。
| イベントの種類 | トリガー |
|---|---|
| Device Data | デバイスが Milesight Development Platform にデータを報告します。 |
| Task Data | タスクが完了しました。 |
| Webhook Test | Test ボタンをクリックして、アプリケーションの呼び出し URI をテストします |
| System Messages | 1 日に利用できる Webhook プッシュの数が制限に達したか、プラットフォームが通知を複数回送信できなかった場合 |
