アクセス トークンは、認証された API 呼び出しを検証するために使用されます。アプリケーションはまずアクセス トークンをリクエストし、その後、Milesight Development Platform API にアクセスするすべてのリクエストにそのトークンを含める必要があります。
前提条件
- Milesight Development Platformでアプリケーションを作成し、以下の項目を取得しています:
- サーバーアドレス
- クライアントID
- クライアントシークレット
リクエストURL
POST {base_url}/oauth/token
リクエストパラメーター
パラメーター | 必須 | タイプ | 説明 |
---|---|---|---|
client_id | Yes | 文字列 | Milesight Development Platformで作成したアプリケーションから取得したClient ID。 |
client_secret | Yes | 文字列 | Milesight Development Platformで作成したアプリケーションから取得したClient Secret。 |
grant_type | Yes | 文字列 | アクセス トークンをリクエストするためのOAuthグラントタイプ。
有効な値: |
レスポンス パラメーター
パラメーター | タイプ | 説明 |
---|---|---|
data | オブジェクト<Token_Details> | リクエストされたトークンの詳細。 |
status | 文字列 | APIリクエストの結果
|
requestId | 文字列 | リクエストのユニークID。リクエストを迅速に特定するために使用できます。 |
- Token_Details
-
パラメーター タイプ 説明 access_token 文字列 API呼び出し用の認証資格情報。すべてのAPIリクエストにはアクセス トークンを含める必要があります。 注意: アクセス トークンが漏洩した場合、Milesight開発プラットフォームでClient Secretを再生成し、新しいものをリクエストできます。以前のものは自動的に無効化されます。
refresh_token 文字列 アクセス トークンを再発行するためのリフレッシュ トークン。 expires_in 整数 アクセス トークンの残りの有効期間(単位:秒)。 refresh_token_expires_in 整数 リフレッシュ トークンの残りの有効期間(単位:秒)。
例
- リクエスト例
-
- クライアント ID とクライアント シークレットを使用してアクセス トークンをリクエストします
POST /oauth/token HTTP/1.1 Host: demo.milesight.com Content-Type: x-www-form-urlencoded client_id=ee6ad650-7d33-414d-bafb-xxxxxxxxxxxx&client_secret=zy6ClNXcTkzTtfPB1tswxxxxxxxxxxxx&grant_type=client_credentials
- レスポンス例
-
HTTP/1.1 200 OK { "data": { "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzQ0NzUwODY0NjY2MDA5NjIifSwiZXhwIjoxNzAyNDU1MDM1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJlYTRiZjYyMS1kMTFiLTRiNmItYTQ5Yi00YWZmODA2ODM4NDAiLCJjbGllbnRfaWQiOiJlZTZhZDY1MC03ZDMzLTQxNGQtYmFmYi0wODM3YjNlMzQzMWQiLCJ0cyI6MTcwMjQ1MTQzNTMzN30.CY_fgSs_Ew7HYF1QgBFOHgJf_YyWo59xbz4iPCCK9zpzqoSX4mRcOo0SpYSk2IkupiZYfw2ZtXb6XNhYLN--wXXuikxWtbxGj4LSO4baUDlzIAZ03dJzZX0nX12b3bmgNtKi6qxxxxxxxxxxxxxxxxxxxxxxxxxx", "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzQ0NzUwODY0NjY2MDA5NjIifSwiYXRpIjoiZWE0YmY2MjEtZDExYi00YjZiLWE0OWItNGFmZjgwNjgzODQwIiwiZXhwIjoxNzA1MDQzNDM1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI4MGRkZDMzMy0wZGVlLTQwYzMtODU3Ny0xNzViOTJlMzIwZDUiLCJjbGllbnRfaWQiOiJlZTZhZDY1MC03ZDMzLTQxNGQtYmFmYi0wODM3YjNlMzQzMWQiLCJ0cyI6MTcwMjQ1MTQzNTMzN30.YN-JqX9RDxAfTElL2ftojqWhJCNyYdtgezRKpFMTUp0H7mtN-07kCL1Ue72vG58gfPh_C87V6joCJsR7_WfpUvQX6kn4jpLRM3JDT0A8D8lk5w5Mul6lBd6bHEtXNxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expires_in": 3599, "refresh_token_expires_in": 2591999 }, "status": "Success", "requestId": "72fea33ad6f721a3a218cc6f60c5fff1" }
関連記事
ソリューション / 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 特定のデバイスを検索する現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。