Skip to content

Latest commit

 

History

History
125 lines (96 loc) · 2.61 KB

url.md

File metadata and controls

125 lines (96 loc) · 2.61 KB
Raw

认证与基础查询

使用 REST API 之前需要创建一个应用，使用应用 ID 与应用密钥作为调用 API。

URL 地址

  • REST API 访问 URL 地址：
https://console.actorcloud.io/api/v1/

认证方式

  • 基于 Basic Auth 认证，用户名为应用 ID，密码为应用密钥：
curl -v --basic -u <AppID>:<AppSecret> -k https://console.actorcloud.io/api/v1/overview/current_count

消息体格式

  • 在 HTTP 请求头中定义以下两个值，并在 POST PUT 请求时发送 JSON 格式文本数据。
Content-Type: 'application/json'
Accept: 'application/json'

响应

  • HTTP Status Code = 20X 可视为操作成功，状态码大于 300 时错误信息会在响应体里返回。

错误信息参考错误处理

资源列表

  • 在资源列表页中，可以使用 URL 参数进行分页查询。

请求示例：

GET /api/v1/products?_page=1&_limit=10

字段说明：

字段 类型 说明
_page Integer 当前页码，默认为 1
_limit Integer 分页大小，默认为 10

成功响应：

{
  "items": [
    {
      "createAt": "2018-03-24 13:59:02",
      "description": "desc",
      "devices": [
        {
          "id": 433
        }
      ],
      "id": 18,
      "productID": "fSPvWw",
      "productName": "默认产品",
      "updateAt": null,
      "userIntID": 6
    },
    {
      "createAt": "2018-03-23 11:38:28",
      "description": "环境监测系列",
      "devices": [
        {
          "id": 427
        },
        {
          "id": 428
        },
        {
          "id": 432
        }
      ],
      "id": 11,
      "productID": "kGBizO",
      "productName": "环境监测",
      "updateAt": null,
      "userIntID": 6
    }
  ],
  "meta": {
    "count": 2,
    "limit": 10,
    "page": 1
  }
}

资源列表响应信息中 items 为资源列表数据，meta 为分页信息。

meta 定义：

字段 类型 说明
count Integer 符合条件总数
limit Integer 分页大小
page Integer 当前页码

查询参数

某些资源中，可以使用 URL 参数进行资源过滤，查询格式：字段名_查询指令=查询值。

请求示例：

GET /api/v1/products?_page=1&_limit=10&productName_like=共享单车

常见查询指令：

指令 类型 说明
*_like -- 模糊查询

具体查询参数参见各资源下文档。