快速开始
本页为使用储能监控开放平台的快速开始api,针对初次使用本系统的用户,帮助用户快速看到设备数据。接口介绍的顺序对应系统体系关系,系统体系层级为 电站业主->项目->采集器->设备 ,下级查询调用接口所需的参数可以在上级接口中返回的数据里获取。
用户,用一个全新的pn码注册电站业主账号(注册成功后会根据注册使用的pn码,创建一个默认项目),在调用业务接口之前,需要先调用认证接口。项目,通过认证之后,加密签名(详见下方描述),查询项目列表(接口)会展示当前用户下的所有项目,返回数据含有项目的基本信息和收益情况,pid(项目id)也是由此接口进行获取。查询项目某天的输出有功功率明细,可以获取到一天全部的功率明细,五分钟一个值。数采器,查询数采器(需要pid),查询项目下的所有数采器。设备,由查询数采器获取到的数据便可以用于查询设备及查询设备某天的数据明细,数据明细返回的数据与设备配置的协议相关联。由此,想要获取设备的数据,接口的调用应该由 项目->采集器->设备 层层递进。
以下为所需接口的简单说明(入参、出参),调用一下接口可快速简单构建平台的体系以便观察设备的数据,如需其他需要请从接口文档中查找。
签名加密
签名加密说明(sign)
注册用户签名
sign = SHA-1(salt + pwd + action)
pwd = RC4(SHA-1(PN), SHA-1(PWD))
action = "&action=reg&usr=" + usr + "&pwd=" +pwd+"&mobile=" + mobile + "&email=" + email + "&sn=" + sn + "&company-key=" + companyKey;
认证签名
sign = SHA-1(salt + SHA-1(pwd) + "&action=authSource&usr=" + usr + "&company-key=" + company-key);
业务api调用签名
sign = SHA-1(salt + secret + token + "&action=...");
secret 和 token 为 通过认证接口之后返回的数据
salt统一说明:salt 为长度不小于8个字节的可读字符串
company-key获取:
邮箱: market@eybond.com
电话: +86-13622344534
用户
注册
用户注册,此阶段需要准备好一个未被注册的数采器编号(以下简称pn) 和 厂家标识 company-key(平台分配的),pn为用户注册接口必传项,使用的地方有签名加密、密码加密、参数(对应sn),详见接口文档
用户注册
注册完成之后会根据pn号生成一个默认项目 PLANT
认证
在调用业务API之前, 总是必需先通过身份认证, 验证成功后获得平台分配的secret与token,用于调用业务接口sign加密计算
认证
返回数据:
{
"err":0,
"desc":"ERR_NONE",
"dat":{
"secret":"ffa1655ee3726840822063a02ac5017795809b18",
"expire":604800,
"token":"88d22d819e31897eea2d9d5b9f7792cf4065ac5372aad3672f5e4e147cd25b5f",
"role":0
}
}
项目
查询项目列表
接口文档链接: 查询项目
查询当前用户下的所有项目信息,通过此接口可以获取到项目的id (pid) 。
pid是调用项目相关接口的重要参数
返回信息:
{ "err":0, "desc":"ERR_NONE", "dat":{ "total":8, "page":0, "pagesize":1, "plant":[ { "pid":1, "uid":1, "name":"PLANT", "status":1, "address":{ "country":"中国", "province":"广东省", "city":"深圳市", "county":"深圳县", "town":"宝安区", "village":"凤凰岗村", "address":"凤凰岗村东四巷", "lon":"101.651442", "lat":"48.144826", "timezone":28800 }, "profit":{ "unitProfit":"1.12", "currency":"¥", "currencyCountry":"CNY", "coal":"0.221", "co2":"0.031", "so2":"0.023" }, "nominalPower":"50000", "energyYearEstimate":"5000000", "designCompany":"EYBOND", "picBig":"http://img.shinemonitor.com/picBig.png", "picSmall":"http://img.shinemonitor.com/picSmall.png", "install":"2017-06-29 02:16:21", "gts":"2017-06-29 02:16:21" } ] } }
查询项目信息
根据pid 查询单个项目的信息,返回数据与项目列表的plant一样
查询项目某天的输出有功功率明细
展示项目某天的输出有功功率,pid为参数必传项
返回参数
{ "err":0, "desc":"ERR_NONE", "dat":{ "outputPower":[ { "val":"29.0001", "ts":"2016-12-31 06:10:10" }, { "val":"30.0001", "ts":"2016-12-31 06:15:10" } ] } }
返回参数说明,outputPower 每一项按照时间正序排列每五分钟一组值 val: 值 ts: 时间 (格式为: yyyy-mm-dd hh:mm:ss)
数采器
查询数采器
查询数采器列表的需要的参数plantid 可以从 查询项目接口 返回的数据中获取
此接口支持分页,详情见 查询数采器
返回数据 dat 关键数据展示
"dat":{ "collector":[ { "pn":"COLLECTOR0001", "datFetch":60, "timezone":28800, "load":1, "uid":1, "pid":1 }, { "pn":"COLLECTOR0002", "datFetch":300, "timezone":28800, "load":1, "uid":1, "pid":1 } ] }
查询数采器下属设备集合
查询数采器下属设备集合,必传参数pn(数采器编号) 可以由查询数采器返回的数据中获取
{ "err":0, "desc":"ERR_NONE", "dat":{ "pn":"COLLECTOR0001", "dev":[ { "devcode":752, "devaddr":1, "sn":"687489900018", "alias":"687489900018" } ] } }
设备
查询设备
调用接口时,参数 pn 、pid 可以由 查询数采器或 查询数采器下属设备集合返回的数据获取
返回数据device关键数据说明
pn: 数采器编号
sn:设备序列号
devcode: 设备协议编码
devaddr: 设备地址(485总线)
"device":[
{
"pn":"COLLECTOR0001",
"devcode":512,
"devaddr":1,
"sn":"687489900018",
"timezone":28800,
"status":1,
"uid":1,
"pid":1
},
{
"pn":"COLLECTOR0002",
"devcode":512,
"devaddr":1,
"sn":"687489900018",
"timezone":28800,
"status":1,
"uid":1,
"pid":1
}
]
查询设备某天的数据明细
查询设备某天的数据明细,此接口必传项参数pn、sn、devcode、devaddr可以由查询设备接口返回的数据中获取
返回数据说明:
title.size()总是等于filed.size()
title 里面存放的是设备协议字段的名称,filed存放的值与协议的字段一 一对应
{
"err":0,
"desc":"ERR_NONE",
"dat":{
"title":[
{
"title":"id"
},
{
"title":"时间戳"
},
{
"title":"序列号"
},
{
"title":"PV1输入电压",
"unit":"V"
},
{
"title":"PV2输入电压",
"unit":"V"
},
{
"title":"PV3输入电压",
"unit":"V"
},
{
"title":"PV1输入电流",
"unit":"A"
},
{
"title":"PV2输入电流",
"unit":"A"
},
{
"title":"PV3输入电流",
"unit":"A"
},
{
"title":"PV1输入功率",
"unit":"W"
},
{
"title":"PV2输入功率",
"unit":"W"
},
{
"title":"PV3输入功率",
"unit":"W"
},
{
"title":"R相电网电压",
"unit":"V"
},
{
"title":"S相电网电压",
"unit":"V"
},
{
"title":"T相电网电压",
"unit":"V"
},
{
"title":"并网功率",
"unit":"W"
},
{
"title":"散热器温度",
"unit":"°C"
},
{
"title":"模块温度",
"unit":"°C"
},
{
"title":"逆变器工作模式"
},
{
"title":"运行时间",
"unit":"Hour"
},
{
"title":"发电时间",
"unit":"Hour"
},
{
"title":"并网次数"
},
{
"title":"总发电量",
"unit":"kWh"
},
{
"title":"启动后功率峰值",
"unit":"W"
},
{
"title":"当天功率峰值",
"unit":"W"
}
],
"row":[
{
"field":[
"bcaa940319ac11e7bde91c6f6593e938",
"2017-04-05 11:06:40",
"687484400018",
"608.4",
"582.9",
"9.8",
"1.76",
"1.56",
"0.07",
"1071",
"914",
"0",
"233.1",
"240.3",
"225.5",
"1977",
"29.6",
"37.4",
"正常",
"120",
"116",
"000067",
"336",
"8668",
"3995"
]
},
Object{...},
Object{...},
Object{...}
]
}
}