1. hapip接口说明

1.1. 文档说明

本文档为hapio组件API接口说明

1.2. 修订记录

日期 文档版本 修订内容 修改人
2021-01-08 v0.1 创建 Ken

1.3. 接口约定

规则 描述
服务器域名(IP) 以部署为准,如: https://xxx.mixiot.top
接口鉴权 令牌机制,详情请阅接口鉴权
字符编码 统一采用UTF-8编码
响应格式 统一采用JSON格式

1.4. 响应说明

1.4.1. 返回码

code 含义 备注
200 请求成功 Code不为200,则说明请求失败
500 请求错误

1.4.2. 格式

1.单条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{}
}

2.多条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{
        "page_index":1,
        "page_size":20,
        "total_pages":0,
        "total_records":0,
        "data":[]
    }
}

1.5. 接口详细

1.5.1. 单指令发送

请求地址:

属性
URL /api/v1/publish
Method post
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
object_id int int(11) --- 对象编号
command string varchar(64) --- 控制指令
value string varchar(64) --- 控制值

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X POST -d '{
    "project_id": 1,
    "object_id": 1,
    "command": "Control_01",
    "value": "1",
}' "https://xxx.mixiot.top/pusher/api/v1/publish"

返回示例:

{
    "code": 200,
    "msg": "成功"
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2021-03-05 16:09:24

results matching ""

    No results matching ""