このトピックでは、Milesight Development Platform APIのリクエスト構造について説明します。これには、HTTPリクエストメソッド、リクエストURL、およびリクエスト認証が含まれます。
制限事項
異なるプランごとのAPIリクエストの最大数を確認するには、ここをクリックしてください。
リクエスト例
以下の例は、Add a Deviceのリクエストを示しています。
POST /device/openapi/v1/devices HTTP/1.1
Host: demo.milesight.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"snDevEUI": "66003649xxxx",
"name": "Sample VS121-P",
"description": "VS121-P on meeting room 3D",
"project": "Workplace-management"
}POSTは、リクエストで使用される指定のHTTPメソッドです。/device/openapi/v1/devicesは、デバイスを追加するためのターゲットAPIエンドポイントです。HTTP/1.1はハイパーテキスト転送プロトコルです。Host: milesight.demo.comはリクエスト URL に含まれる ベース URL であり、Milesight Development Platform のドメイン名です。Authorization: Bearer {access_token}は リクエスト認証に使用されます。
リクエストメソッド
Milesight Development Platform API は以下の HTTP メソッドをサポートしています:
| HTTP メソッド | 用途 |
|---|---|
| GET | Milesight Development Platform からデータを取得します。 |
| POST | Milesight Development Platformにデータを送信し、新しいリソースを作成したり、特定の操作を実行します。 |
| PUT | Milesight Development Platform上の既存のリソースを更新します。 |
| DELETE | Milesight Development Platform上の特定の リソースを削除します。 |
| PATCH | Milesight Development Platform上のリソースの増分更新に使用されます。 |
リクエストURL
Milesight Development Platform APIのリクエストURL形式は次のとおりです：
{base_url}/{endpoint}- base_url
-
- Base URL は API をホストするサーバーのドメイン名です。つまり、Milesight Development Platform のサーバーアドレスです:
https://{Milesight Development Platform server address} -
- アプリケーションを作成した後、サーバーアドレスは Authentication セクションで確認でき、API 呼び出しの base_url として使用します。
- endpoint
-
- Endpoints は、API を通じてアクセスおよび操作可能な異なるリソースまたは機能を表します。Milesight Development Platform API のエンドポイントは、以下の形式で構成されています：
/{serviceName}/openapi/{version}/**- Milesight Development Platform API のすべての利用可能なエンドポイントは、API インターフェース一覧を参照してください。
リクエスト認証
サードパーティアプリケーションがアクセス トークンを取得した後、そのトークンを使用して API 呼び出しを行うことができます。Milesight Development Platform API にアクセス トークンを送信する方法は2つあります。
注: HTTPヘッダーの使用は、URLに表示されるクエリ文字列パラメーターが露出する可能性があるため、クエリ文字列よりも一般的に推奨されます。したがって、このドキュメントでは、Authorization Bearer認証方法に基づくAPIの例を提供します。
-
- Authorization Bearer HTTPヘッダーの使用（推奨）
- アクセス トークンを
Authorization:BearerHTTPヘッダーに送信します。以下のコード例を参照してください -
POST /service/openapi/v1/devices Host: milesight.demo.com Authorization: Bearer {access_token}
-
- アクセス トークン クエリ文字列パラメーターの使用
- アクセス トークンをクエリ文字列パラメーター
- で送信することもできます。以下のコードを参照してください。
POST https://demo.milesight.com/devices?access_token={access_token}
