▢1.2 APIとWebhookの活用
目次
Milesight Development Platform をお選びいただき、ありがとうございます。ここでは、プラットフォームをサードパーティのアプリケーションと迅速に統合するための主な手順をご説明します。
ビデオチュートリアル
ステップ 1. アプリケーションの作成
注： Milesight Development Platform は、機能に慣れるため、またはハードウェアデバイスがない場合でも簡単にディスプレイデモを設定できるように、アカウントごとに 1 つのデモアプリケーションを自動的に生成します。
Milesight Development Platform を使用するには、アプリケーションを作成する必要があります。
詳細については、「アプリケーションの作成」をご覧ください。
-
ステップ 2. アプリケーションにデバイスを追加する
Milesight Development Platform では、API および Webhook を迅速にテストするために、デモデバイスまたは実際のデバイスをアプリケーションに追加することができます。
- Application Devices タブで、Add A Demo Device をクリックします。
- 製品モデルのチェックボックスをオンにし、プロファイルバージョンまたは TSL バージョンを選択して、OK をクリックします。
詳細については、「アプリケーションにデバイスを追加する」を参照してください。
ステップ 3. 統合および開発に API を利用する
Milesight Development Platform は、主に 2 つの機能に関する API を提供しています。
- デバイス管理：デバイスの追加、管理、設定。
- RPS 管理：RPS のプロファイル URL を照会および指定し、RPS レコードを管理。
詳細については、「Milesight Development Platform API の概要」を参照してください。
- 「OpenAPI DEBUGタブで、テストする OpenAPI バージョンと API を選択します
注：-
- OpenAPI は、Postman などの他の API ツールにダウンロードしてインポートすることもできます。
- 他の API ツールまたはアプリケーションで API をテストする場合は、アクセス トークンを取得する必要があります。
-
- デバッグ パネルに必要なパラメータを入力し、「Send」をクリックします。API およびパラメータの詳細については、API インターフェース一覧をご覧ください。
-
ステップ 4. Webhook 経由でリアルタイムの通知を受け取る
Milesight Development Platform は、デバイスが Milesight Development Platform にデータを報告したときに、サードパーティのアプリケーションにリアルタイムの通知を受け取るための Webhook イベント通知の設定をサポートしています。詳細については、「イベント通知の概要」を参照してください。
- アプリケーション設定] タブで、Webhook オプションを有効にして Webhook イベントを購読します。
-
- Callback URI セクションで、Add をクリックします。
- イベント通知を受信するための Webhook コールバック URI を入力します。
- Test をクリックして、Webhook が正常に動作しているか確認します。テスト通知が、入力したすべての Webhook コールバック URI に送信されます。
- このアプリケーションの右下隅にあるDevice Debug Panel アイコンをクリックします。
- 必要なシミュレートレポートを生成します。
-
- レポートをシミュレートするデバイスを選択します。
- Report タブで、レポートの種類を選択します。
- 報告するデータ項目を1つまたは複数選択します。注意: 複数の項目を選択した場合、選択したすべての項目を含む1つのメッセージを生成するには、Batch Report ボタンをクリックします。
- Random Report または Custom Report をクリックしてレポートを送信します。
-
