- Home
- 開発プラットフォーム
- 3.1.1.2 API レスポンス結果
3.1.1.2 API レスポンス結果
目次
1. はじめに
2. ユーザーガイド
- ▢2.1 アカウントとデータセンター
- ▢2.2 ダッシュボードの概要
- ▢2.3 アプリケーション概要
- ▢2.4 デバイスの概要
- 2.4.1 デバイスの追加
- 2.4.2 デバイスの管理
- 2.4.3 デバイスの設定
- 2.4.4 デバイスのアップグレード
- 2.4.5 デバイスの共有
- 2.4.6 リモートアクセスデバイス
- 2.4.7 デバイスリストの列をカスタマイズする
- ▢2.5 リソース概要
- ▢2.6 タスク センター 概要
- ▢2.7 RPSの概要
- ▢2.8 Userの概要
3. APIレファレンス
- ▢3. Milesight開発プラットフォームAPIの概要
- 3.1.1 APIリクエスト
- 3.1.2 API インターフェース一覧
- 3.1.3 API 認証
- 3.1.4 デバイス管理
- 3.1.5 RPS管理
- 3.1.6 タスク管理
- 3.2 Webhookイベント通知
4. デバイスレファレンス
5. よくある質問
APIリクエストを受信すると、Milesight Development Platformはリクエストの結果を示すHTTPステータスコードと、API呼び出しで要求された情報を含むJSONレスポンスボディを返します。
成功レスポンスの例
- 説明
-
リクエストが成功した場合、Milesight Development PlatformはHTTPステータスコード200を返し、API呼び出しで要求された情報を含むレスポンスボディを返します。以下の表に示します:
- パラメーター
- タイプ
- 説明
data - オブジェクト
- API呼び出しで要求された詳細情報
status - 文字列
- リクエストの結果。成功レスポンスでは、ステータスは
Successです。
requestId 文字列 リクエストのユニークIDで、リクエストを迅速に特定するために使用できます。
- 例
-
- 以下の例は、Get an Access Tokenの成功レスポンスを示します。
-
HTTP/1.1 200 OK { "data": { "access_token": "eyJhbGciOiJSUzI1iIsR5xxxxxxxxxxxxxxxxxxxxxxxxxx", "refresh_token": "eyJhbGciOiJSUz1N8l6bHEtXNxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expires_in": 3599 "refresh_token_expires_in": 2591999 }, "status": "Success", "requestId": "72fea33ad6f721a3a218cc6f60c5fff1" }
エラー応答例
- 説明
-
- リクエストが失敗した場合、Milesight Development PlatformはHTTP
4xxまたは500ステータスコードを返し、エラーを迅速に解決しリクエストを修正するのに役立つ詳細なエラーメッセージを返します。
パラメーター タイプ 説明 status 文字列 リクエストの結果。 エラー応答の場合、ステータスは
Failedです。requestId 文字列 リクエストのユニークID。リクエストを迅速に特定するために使用できます。 errCode 文字列 エラーの原因 errMsg 文字列 エラーの詳細な具体的な情報。 - リクエストが失敗した場合、Milesight Development PlatformはHTTP
- 例
-
- 以下の例は、無効な認証資格情報でアクセス トークンをリクエストした際のエラー応答を示します。
-
HTTP/1.1 401 Unauthorized { "status": "Failed", "requestId": "7bc8257ddaac3e87321f11221960d0f9", "errCode": "authentication_failed", "errMsg": "Bad credentials" }
関連記事
ソリューション / IoT サポート
- ▢3. Milesight開発プラットフォームAPIの概要 2025年6月21日システムをサードパーティのアプリケーションと統合するためのアプリケーションプログラミングインターフェース (API) を提供しています
- 3.1.1.1 APIリクエスト構造 2025年6月21日Milesight Development Platform APIのリクエスト構造について説明します
- 3.1.1.2 API レスポンス結果 2025年6月21日APIリクエストを受信すると、Milesight Development Platformはリクエストの結果を示すHTTPステータスコードと、API呼び出しで要求された情報を含むJSONレスポンスボディを返します。
- 3.1.2 API インターフェース一覧 2025年6月21日このトピックでは、Milesight Development Platform API のインターフェースの要約リストを提供します。
- 3.1.3.1 API 認証ルール 2025年6月21日Milesight Development Platform APIは、OAuth 2.0を使用して認証を行い、アプリケーションがMilesight Development Platform上のリソースにアクセスするためのセキュアなトークンを発行します。
- 3.1.3.2 API アクセス トークンの取得 2025年6月21日アクセス トークンは、認証された API 呼び出しを検証するために使用されます。アプリケーションはまずアクセス トークンをリクエストし、その後、Milesight Development Platform API にアクセスするすべてのリクエストにそのトークンを含める必要があります。
- 3.1.3.3 API アクセス トークンの更新 2025年6月21日Milesight Development Platformとアプリケーション間の安全でスムーズな通信を確保するため、アクセス トークンが有効期限切れになる前に更新する必要があります。
- 3.1.4.1 デバイスを追加する 2025年6月21日Milesight Development Platform にデバイスを追加し、現在のアプリケーションに関連付けます。
- 3.1.4.2 特定のデバイスを検索する 2025年6月21日現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。
- 3.1.4.3 特定のデバイスをクエリする 2025年6月21日特定のデバイスの詳細情報を照会します。
- 3.1.4.4 デバイスのTSLモデルを照会する 2025年6月21日デバイスの TSL (Thing Specification Language) モデルをクエリします。
- 3.1.4.5 プロパティ レポートの履歴データを照会する 2025年6月21日デバイスプロパティレポートの履歴データを照会するためのインターフェースについて紹介します。
- 3.1.4.6 デバイス サービスを非同期に呼び出す 2025年6月21日デバイスのサービスを非同期で呼び出します。
- 3.1.4.7 デバイス情報の更新 2025年6月21日デバイスの名前、説明、およびタグを更新します。
- 3.1.4.8 デバイス プロパティを段階的に更新する 2025年6月21日デバイスのプロパティを段階的に更新します。これは、単一のデバイスおよび単純なパラメータの更新に適しています。
- 3.1.4.9 デバイスを削除する 2025年6月21日Milesight Development Platform からデバイスを削除します。
- 3.1.4.X アプリケーションからデバイスを削除する 2025年6月21日Milesight Development Platform のアプリケーションからデバイスを削除します。
- 3.1.4.XI 特定のデバイスの設定を取得する 2025年6月21日特定のデバイスの詳細な設定を照会します。
- 3.1.5.1 RPS用のプロファイルURLを指定する 2025年6月21日デバイスの RPS (リダイレクトおよびプロビジョニングサービス) でプロファイル URL を指定します。
- 3.1.5.2 クエリ プロファイル URL リスト 2025年6月21日現在のアプリケーション内のプロファイル URL リストを照会します。
- 3.1.5.3 デバイスのRPSレコードの削除 2025年6月21日RPS のプロファイル URL を指定してデバイスを Milesight Development Platform に追加する場合、またはデバイスを別のプラットフォームに転送する場合は、RPS レコードの一意性を確保するために、デバイスの現在の RPS レコードを削除する必要があります。
- 3.1.6.1 構成タスクの作成 2025年6月21日リモートデバイスに設定を適用するための設定タスクを作成します。これは、大量のデバイスや設定パラメータが多い場合に適しています。単一のデバイスや単純なパラメータの更新については、「デバイスプロパティの段階的な更新」を参照してください。
- 3.2.1 イベント通知の概要 2025年6月21日要件、Webhook ワークフロー、サポートされている Webhook イベントなど、Milesight Development Platform Webhook の概要について詳しく説明します。
- 3.2.2 Webhook イベント通知の設定 2025年6月21日サードパーティのアプリケーションが、デバイスが Milesight Development Platform にデータを報告したときにリアルタイムの通知を受け取ることができるように、Webhook イベント通知を設定する方法について説明します。
- 3.2.3.1 デバイスデータ 2025年6月21日イベント「DEVICE_DATA」の例と説明について説明します。
- 3.2.3.2 タスクデータ 2025年6月21日イベント「TASK_DATA」の例と詳細について説明します。
- 3.2.3.3 Webhook テスト 2025年6月21日イベント「WEBHOOK_TEST」の例と解説について説明します。
- 3.2.3.4 システムメッセージ 2025年6月21日イベント「SYSTEM_MESSAGES」の例と説明を提供します。
