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の概要システムをサードパーティのアプリケーションと統合するためのアプリケーションプログラミングインターフェース (API) を提供しています
- 3.1.1.1 APIリクエスト構造Milesight Development Platform APIのリクエスト構造について説明します
- 3.1.1.2 API レスポンス結果APIリクエストを受信すると、Milesight Development Platformはリクエストの結果を示すHTTPステータスコードと、API呼び出しで要求された情報を含むJSONレスポンスボディを返します。
- 3.1.2 API インターフェース一覧このトピックでは、Milesight Development Platform API のインターフェースの要約リストを提供します。
- 3.1.3.1 API 認証ルールMilesight Development Platform APIは、OAuth 2.0を使用して認証を行い、アプリケーションがMilesight Development Platform上のリソースにアクセスするためのセキュアなトークンを発行します。
- 3.1.3.2 API アクセス トークンの取得アクセス トークンは、認証された API 呼び出しを検証するために使用されます。アプリケーションはまずアクセス トークンをリクエストし、その後、Milesight Development Platform API にアクセスするすべてのリクエストにそのトークンを含める必要があります。
- 3.1.3.3 API アクセス トークンの更新Milesight Development Platformとアプリケーション間の安全でスムーズな通信を確保するため、アクセス トークンが有効期限切れになる前に更新する必要があります。
- 3.1.4.1 デバイスを追加するMilesight Development Platform にデバイスを追加し、現在のアプリケーションに関連付けます。
- 3.1.4.2 特定のデバイスを検索する現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。