3.1.1.2 API レスポンス結果

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 文字列 エラーの詳細な具体的な情報。
以下の例は、無効な認証資格情報でアクセス トークンをリクエストした際のエラー応答を示します。
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 特定のデバイスを検索する
    現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。

Milesight製品

ウェーブクレスト株式会社が運営するMilesight製品特設サイトです

居住者の健康を確保

お知らせ

  1. 2025-4-3

    ピープル・センシング 駆動型スマートビルディング

    People Sensing Insights を通じてビルインテリジェンスに革命をもたらします。…
  2. 2023-7-21

    LoRaWANの説明: 理論から実践へのガイド

    この包括的なビデオでは、LoRaWANを深く掘り下げ、その仕組み、利点、アプリケーションについて説明…
  3. 2023-4-6

    センシング・インサイト Milesight リブランディングのお知らせ

    https://youtu.be/r40DK40DjIY …
ページ上部へ戻る