采集器添加

接口地址

地址：/Api_v2/collector/add

接口参数

字段名	变量名	必填	类型	描述
授权码	auth_code	✔️	String(32)	系统为使用区域分配的授权码，在后台配置页面获取
时间戳	timestamp	✔️	String(10)	自1970年1月1日（08:00:00 GMT）至当前时间的总秒数
请求内容	request_content	✔️	String	传入采集器号列表添加指定的采集器
签名	sign	✔️	String(32)	通过签名算法计算得出的签名值，详见签名生成算法

request_content字段说明

字段名	变量名	必填	类型	描述
采集器号	cid	✔️	String	采集器号,4G、NB设备采集器号与表号一致

请求内容示例

{
  "auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
  "timestamp": "1586740681",
  "request_content": [
    {"cid": "12345678901"},
    {"cid": "19020618114"}
  ],
  "sign": "fee536cf6a37a200d6761df04f5bf368"
}

返回结果

字段名	变量名	必填	类型	示例值	描述
返回状态码	status	✔️	String	SUCCESS	SUCCESS/FAIL，此字段是通信标识
时间戳	timestamp	✔️	String(10)	1586744791	自1970年1月1日（08:00:00 GMT）至当前时间的总秒数
回复内容	response_content	✔️	String	见下方说明	详见response_content字段说明
签名	sign	✔️	String(32)	d0442d8cd04d85221bc940e7a5a12c35	通过签名算法计算得出的签名值，详见签名生成算法
出错原因	error_msg	❌	String	授权码错误	当返回状态码为"FAIL"时，返回信息为错误原因

回复内容response_content字段说明

点击查看详细说明

字段名	变量名	必填	类型	示例值	描述
采集器号	cid	✔️	String(12)	100000000101	采集器号,4G、NB设备采集器号与表号一致
在线状态	online	❌	Boolean	false	采集器是否在线
离线时间	disconnect_time	❌	String(19)	2000-01-01 00:00:00	采集器最后一次离线时间，online为false时填写
连接时间	connect_time	❌	String(19)	2020-04-20 09:25:55	采集器连接时间，online为true时填写
添加状态	status	✔️	String	SUCCESS	采集器添加结果状态码，"SUCCESS"， "FAIL"
错误原因	error_msg	❌	String	未找到采集器	采集器添加状态码不是"SUCCESS"时，返回信息为错误原因

TIP

response_content 返回的是一个 JSON 数组，每个元素代表一个采集器的添加结果。例如：

[
  {
    "status": "FAIL",
    "error_msg": "采集器号已被注册",
    "cid": "12345678901"
  },
  {
    "online": true,
    "connect_time": "2020-04-20 09:25:55",
    "status": "SUCCESS",
    "cid": "19020618114"
  }
]

接口测试工具