请求结构说明

本文档介绍了星纵物联开放平台的API请求结构，包括HTTP请求、请求URL和身份验证的方式。

请求示例

以下是一个请求的例子添加设备.

POST /device/openapi/V1.0/devices HTTP/1.1
Host: milesight.demo.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
User-Agent: OpenAPI

{
    "snDevEUI": "66003649xxxx",
    "name": "Sample VS121-P",
    "description": "VS121-P on meeting room 3D",
    "project": "Workplace-management"
}
  • POST 表示请求方式HTTP 方式 。
  • /device/openapi/V1.0/devices 即API路径，表示API版本 API终端 用于添加一个设备。
  • HTTP/1.1为超文本传输协议。
  • Host: milesight.demo.com 表示星纵物联开放平台软件版的IP地址 基础URL中的请求表示星纵物联开放平台的域名。
  • Authorization: Bearer {access_token}表示 请求身份验证。

请求方式

星纵物联开放平台API支持以下几种HTTP请求方式

HTPP请求方式 说明
GET 查询星纵物联开放平台数据
POST 向星纵物联开放平台发送数据，用于创建新资源或执行特定操作。
PUT 更新星纵物联开放平台上已有的资源
DELETE 删除星纵物联开放平台上的特定资源。
PATCH 在星纵物联开放平台上进行资源的更新

请求

星纵物联开放平台API请求URL格式如下。
{base_url}/{endpoint}
基础 URL
基础URL是API所在服务器的域名，即星纵物联开放平台的服务器地址：
https://{Milesight Development Platform server address}
此处After you 创建应用, 在认证部分找到服务器地址，用作base_url进行API调用。

终端

终端可以通过API访问和交互的不同资源或功能。星纵物联开放平台 API的终端构建格式如下：

/{serviceName}/openapi/{version}/**
有关星纵物联开放平台 API所有可用的终端，请参考API 接口概览。

请求身份验证

第三方应用程序链接获取访问令牌 , 将访问令牌传递给星纵物联开放平台 API有两种方式，可以使用令牌进行API调用。
注： 通常使用HTTP优于查询字符串，因为在URL中查询字符串参数可能会被暴露。因此，本文档将提供基于 Authorization Bearer的API示例。
优先使用Authorization Bearer HTTP（首选）
将访问令牌发送到HTTP中的Authorization:Bearer，如以下代码所示。
POST /service/openapi/v1.0/devices
Host: milesight.demo.com
Authorization: Bearer {access_token}
使用访问令牌查询字符串参数
你还可以通过查询字符串参数 access_token 发送访问令牌，如以下代码所示。
POST https://milesight.demo.com/devices?access_token={access_token}