1. hapig接口说明

1.1. 文档说明

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

1.2. 修订记录

日期 文档版本 修订内容 修改人
2020-10-13 v0.1 添加栅格接口 lizefang

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/grid/getLastItem
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
terminal_id string --- --- 编号
topic string --- --- 主题

响应参数:

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

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/hapig/api/v1/grid/getLastItem?terminal_id=test&topic=r"

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": [
        {
            "payload": {
                "L4_3_150": 36
            },
            "time": "2020-10-13 15:25:23",
            "topic": "r"
        }
    ]
}

1.5.2. 查询某⼀个时刻的一条栅格数据

请求地址:

属性
URL /api/v1/grid/getItemByTime
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
terminal_id string --- --- 编号
topic string --- --- 主题
time string --- --- 时间

响应参数:

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

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/hapig/api/v1/grid/getItemByTime?terminal_id=test&topic=r&time=2020-10-13T11:28:41Z

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": [
        {
            "payload": {
                "L4_3_150": 36
            },
            "time": "2020-10-13 11:28:42",
            "topic": "r"
        }
    ]
}

1.5.3. 查询最新的指定数量的栅格数据

请求地址:

属性
URL /api/v1/grid/getLastListByItem
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
terminal_id string --- --- 编号
topic string --- --- 主题
items string --- --- 条数

响应参数:

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

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/hapig/api/v1/grid/getLastListByItem?terminal_id=test&topic=r&items=3

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "data": [
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:43",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:33",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:23",
                "topic": "r"
            }
        ]
    }
}

1.5.4. 查询最新的一段时间内指定数量的栅格数据

请求地址:

属性
URL /api/v1/grid/getListByDuration
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
terminal_id string --- --- 编号
topic string --- --- 主题
page_index string --- --- 页数
page_size string --- --- 每页条数
start_time string --- --- 开始时间
end_time string --- --- 结束时间

响应参数:

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

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/hapig/api/v1/grid/getListByDuration?terminal_id=test&page_index=1&page_size=100&start_time=2020-10-12T09:40:42Z&end_time=2020-10-13T16:41:22Z&topic=r

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "data": [
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:43",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:33",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:23",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:13",
                "topic": "r"
            },
            {
                "payload": {
                    "L4_3_150": 36
                },
                "time": "2020-10-13 16:26:03",
                "topic": "r"
            }
        ],
        "page_index": 1,
        "page_size": 10,
        "total_pages": 251,
        "total_records": 2509
    }
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2021-03-05 16:09:24

results matching ""

    No results matching ""