top

建恒流量计服务器使用说明——流量计端

基本信息:

服务器的域名:https://api.gentos.hengxiao.net/
服务器使用说明文档:https://api.gentos.hengxiao.net/

以下均以JSON为例。对应HTTP Header为:

Content-Type: application/json
Accept: application/json

同时支持以XML格式收发信息。对应HTTP Header为:

Content-Type: application/xml
Accept: application/xml
XML的格式将与JSON类似。


流量计注册

地址:https://api.gentos.hengxiao.net/v1/flowmeter/auth/register

用POST的形式发送一个JSON对象。
serial_number是流量计的ID。格式为整形(整数)。
每一个流量计应该有一个独有且(在大多数情况下)不变的serial_number


接受的信息是一个JSON对象,其中包含password
password应该存储在流量计中。之后用于验证流量计身份。

/* 发送消息的格式 */
{
  "serial_number": integer
}

/* 接受消息的格式 */
{
  "password": string
}

流量计登陆

地址:https://api.gentos.hengxiao.net/v1/flowmeter/auth/get-access-token/

用POST的形式发送一个JSON对象。
serial_number是流量计的ID。
password是流量计在注册时,服务器给流量计提供的密码。


接收的信息是一个JSON对象。其中包含access_token。
access_token是用于在已登陆的情况下验证流量计信息的。 登陆状态在一定时间后会过期。
如果流量计在未登录,或access_token已过期的情况下,尝试上传信息,
或尝试用错误信息登陆,那么上传信息的请求会被以401 Unauthorized拒绝。

/* 发送消息的格式 */
{
  "serial_number": integer,
  "password": string
}

/* 接受消息的格式 */
{
  "access_token": string
}  

上传数据——流量

地址:https://api.gentos.hengxiao.net/v1/flowmeter/flow/update/

用POST的形式发送一个JSON对象
access_token是在流量计登陆时获得的。用于验证流量计身份。
value是流量数据
measure_time是该流量数据录得的时间

/* 发送消息的格式 */
{
  "access_token": string,
  "value": number,
  "measure_time": string /* JSON的日期时间格式 */
}

/* 200 OK表示数据上传成功 */