Skip to content

数据获取 API(第三方授权)

数据获取 API 提供逆变器、采集器、EPM、气象仪及电站的数据查询接口。本文档介绍第三方授权(OAuth2.0 Bearer Token)方式的接口调用方法。

项目说明
API 基础地址https://api-oauth2.soliscloud.com/
认证方式OAuth2.0 Bearer Token

通用响应格式

所有接口返回统一的 JSON 结构:

json
{
    "success": true,
    "code": "0",
    "msg": "success",
    "data": { }
}
字段类型说明
successbooleantrue 表示成功,false 表示失败
codestring"0" 表示成功,其他表示失败(见附录)
msgstringcode 值的描述
dataobject/array具体业务数据

分页说明

数据获取接口统一使用游标分页

说明
排序固定按各接口对应的业务主键 id 升序,与各接口 minId 说明中的字段一致
首次请求不传 minId,从最小 id 开始返回
继续翻页传入 minId = 上一页最后一条记录的 id + 1minId 为包含边界,传上页最后一条 id 会导致该条重复返回)
单页条数pageSize,默认 20,最大 100
是否还有下一页返回记录数等于 pageSize 说明可能还有下一页;小于 pageSize 说明已到末尾
total固定为 0,不再返回真实总数

频率限制

接口类型限制
数据获取接口10 次/秒
设备数据上报频率5 分钟

TIP

如果限流无法满足业务需求,请参考 实时数据转发 切换为队列数据转发。


认证方式

认证方式详见 授权方式

请求头需携带 OAuth2.0 Bearer Token:

Header 参数说明
Content-Typeapplication/json;charset=UTF-8
AuthorizationBearer {access_token}

接口列表

逆变器接口

接口路径说明
逆变器列表inverterList获取账号下逆变器列表
逆变器详情inverterDetail获取单台逆变器详情
逆变器日数据inverterDay获取单台逆变器某日实时数据
逆变器月数据inverterMonth获取单台逆变器某月日数据
逆变器年数据inverterYear获取单台逆变器某年月数据
逆变器累计数据inverterAll获取单台逆变器累计数据
逆变器质保数据inverter/shelfTime获取逆变器质保数据
报警列表alarmList获取设备报警列表

采集器接口

接口路径说明
采集器列表collectorList获取账号下采集器列表
采集器详情collectorDetail获取单台采集器详情
采集器信号值collector/day获取采集器信号值

EPM 接口

接口路径说明
EPM 列表epmList获取账号下 EPM 列表
EPM 详情epmDetail获取单台 EPM 详情
EPM 日数据epm/day获取单台 EPM 某日实时数据
EPM 月数据epm/month获取单台 EPM 某月日数据
EPM 年数据epm/year获取单台 EPM 某年月数据
EPM 累计数据epm/all获取单台 EPM 累计数据

气象仪接口

接口路径说明
气象仪列表weatherList获取气象仪列表
气象仪详情weatherDetail获取单台气象仪详情

电站接口

接口路径说明
电站列表userStationList获取账号下电站列表
电站详情stationDetail获取单个电站详情
电站日发电量列表stationDayEnergyList获取多个电站某日数据
电站月发电量列表stationMonthEnergyList获取多个电站月数据
电站年发电量列表stationYearEnergyList获取多个电站年数据
电站日数据stationDay获取单个电站某日实时数据
电站月数据stationMonth获取单个电站某月日数据
电站年数据stationYear获取单个电站某年月数据
电站累计数据stationAll获取某个电站累计数据

逆变器接口详情

获取逆变器列表

获取账号下逆变器列表,单次调用最多获取 100 台设备数据。

接口路径POST /api/access_data/inverterList

请求参数

参数类型必填说明
stationIdInteger指定电站 ID,查询该电站下逆变器
plantIdString电站编码,可从电站列表或数据转发中获取,与 stationId 效果相同
nmiCodeString澳洲发电户号(NMI),澳大利亚地区专用
snListArray指定批量 SN 查询逆变器列表
minIdLong起始 id(含),按 inverter_id 升序翻页;不传则从最小 id 开始

响应参数(data):

参数类型说明
pageObject分页结果
page.totalInteger固定为 0(游标分页不返回真实总数)
page.recordsArray逆变器列表
inverterStatusVoObject逆变器状态统计
inverterStatusVo.allInteger总数量
inverterStatusVo.normalInteger正常数量
inverterStatusVo.offlineInteger离线数量
inverterStatusVo.faultInteger故障数量

records 字段

参数类型说明
idNumber逆变器 ID
snString逆变器 SN
stationIdInteger电站 ID
stationNameString电站名称
powerString装机容量
powerStrString容量单位
etodayNumber今日发电量
etodayStrNumber电量单位
etotalNumber累计发电量
etotalStrNumber总电量单位
fullHourNumber满发小时
pacNumber功率
pacStrNumber功率单位
stateInteger状态:1=在线,2=离线,3=告警
dataTimestampInteger更新时间
collectorSnString采集器 SN
productModelString逆变器型号
dcInputTypeInteger直流输入通道(值+1=实际)
acOutputTypeInteger交流输出类型:0=单相,其他=三相
inverterMeterModelInteger逆变器电表类型,见附录 3

获取逆变器详情

接口路径POST /api/access_data/inverterDetail

请求参数

参数类型必填说明
idNumber逆变器 ID,id 和 sn 不能同时为空
snString逆变器 SN

响应参数(data):包含列表所有字段,以及:

参数类型说明
eToday/eMonth/eYear/eTotalNumber今日/月/年/累计发电量
facNumber电网频率
pacNumber实时功率
iAc1/iAc2/iAc3Number交流电流 R/S/T
uAc1/uAc2/uAc3Number交流电压 R/S/T
iPv1~iPv32Number直流电流 1~32
uPv1~uPv32Number直流电压 1~32
batteryCapacitySocNumber电池 SOC
batteryPowerNumber电池功率
batteryCapacityNumber电池容量
gridPurchasedTodayEnergyNumber今日电网购电量
gridSellTodayEnergyNumber今日电网售电量
familyLoadPowerNumber家庭负载功率
pSumNumber电网总有功功率
inverterMeterModelInteger电表类型,见附录 3
typeInteger逆变器类型:1=并网,2=储能
hmiVersionAllStringHMI版本号全量

逆变器日/月/年/累计数据

逆变器日数据

接口路径POST /api/access_data/inverterDay

参数类型必填说明
idNumber逆变器 ID
snString逆变器 SN
moneyString货币单位,如 CNY
timeString日期,格式 yyyy-MM-dd
timeZoneInteger电站时区

响应参数(data 数组):

参数类型说明
dataTimestampInteger更新时间
timeStrString时间字符串
pacNumber功率
eTodayNumber今日发电量
eTotalNumber累计发电量
uPv1~uPv4Number直流电压 1~4
iPv1~iPv4Number直流电流 1~4
batteryCapacitySocNumber电池 SOC
batteryPowerNumber电池功率

逆变器月数据

接口路径POST /api/access_data/inverterMonth

参数类型必填说明
id/sn-逆变器 ID 或 SN
moneyString货币单位
monthString月份,格式 yyyy-MM

响应参数(data 数组):

参数类型说明
energyNumber发电量
energyStrString电量单位
dateString日期
moneyNumber收益
moneyStrString收益单位
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
gridPurchasedEnergyNumber电网购电量
gridSellEnergyNumber电网售电量

逆变器年数据

接口路径POST /api/access_data/inverterYear

参数类型必填说明
id/sn-逆变器 ID 或 SN
moneyString货币单位
yearString年份,格式 yyyy

响应参数(data 数组):同月数据。

逆变器累计数据

接口路径POST /api/access_data/inverterAll

参数类型必填说明
id/sn-逆变器 ID 或 SN
moneyString货币单位

响应参数(data 数组):

参数类型说明
yearString年份
energyNumber发电量
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
gridPurchasedEnergyNumber电网购电量
gridSellEnergyNumber电网售电量

获取逆变器质保数据

接口路径POST /api/access_data/inverter/shelfTime

参数类型必填说明
snString单个或多个 SN,逗号分隔,最多 1000 个
minIdLong起始 id(含),按 id 升序翻页;不传则从最小 id 开始

响应参数(data.page.records):

参数类型说明
idNumber逆变器 ID
snString逆变器 SN
shelfBeginTimeString质保开始时间
shelfEndTimeString质保结束时间
shelfTimeString质保时长
shelfStateInteger质保状态:0=质保中,1=已过期

获取报警列表

接口路径POST /api/access_data/alarmList

参数类型必填说明
stationIdInteger电站 ID
plantIdString电站编码,与 stationId 效果相同
alarmDeviceSnString逆变器 SN
alarmBeginTimeString开始日期,yyyy-MM-dd
alarmEndTimeString结束日期,yyyy-MM-dd
nmiCodeString澳洲发电户号(NMI),澳大利亚地区专用
StateInteger0=未处理,1=已处理,2=已恢复
minIdLong起始 id(含),按 alarmId 升序翻页;不传则从最小 id 开始

响应参数(data.page.records):

参数类型说明
stationIdInteger电站 ID
stationNameString电站名称
alarmDeviceSnString告警设备 SN
alarmCodeString告警码
alarmLevelInteger告警级别:1=提示,2=一般,3=紧急
alarmBeginTimeString告警开始时间
alarmEndTimeString告警结束时间
alarmMsgString告警信息
adviceString处理建议
stateInteger状态:0=未处理,1=已处理,2=已恢复
warningInfoDataObject告警扩展数据

采集器接口详情

获取采集器列表

参数:stationId、plantId、nmiCode、minId(起始 id,含,按 collector_id 升序翻页)。

接口路径POST /api/access_data/collectorList

响应参数

参数类型说明
collectionStatusVoObject采集器状态统计:all/normal/offline/fault
page.recordsArray采集器列表

records 字段

参数类型说明
idNumber采集器 ID
snString采集器 SN
stationIdInteger电站 ID
modelString采集器型号
nameString采集器名称
rssiLevelInteger信号强度等级
stateInteger状态:1=在线,2=离线,3=告警
dataTimestampInteger更新时间
contractTimeString合同时间

获取采集器详情

参数:id 或 sn(不能同时为空)。

接口路径POST /api/access_data/collectorDetail

响应参数

参数类型说明
idNumber采集器 ID
snString采集器 SN
stationIdInteger电站 ID
stateInteger状态:1=在线,2=离线,3=告警
modelString采集器型号
rssiLevelInteger信号强度等级
maximumNumberInteger最大接入数
actualNumberInteger实际接入数
currentWorkingTimeInteger当前工作时长
totalWorkingTimeInteger累计工作时长
dataUploadCycleInteger数据上传周期
factoryTimeString出厂时间
contractTimeString合同时间

获取采集器信号值

参数:sn、time(yyyy-MM-dd)、timeZone。

接口路径POST /api/access_data/collector/day

响应参数(data 数组):

参数类型说明
collectorIdNumber采集器 ID
collectorSnString采集器 SN
dataTimestampInteger更新时间
timeStrString时间字符串
pecNumber信号百分比(%)
rssiNumber信号强度
rssiLevelInteger信号强度等级

EPM 接口详情

获取 EPM 列表

参数:stationId、plantId、nmiCode、minId(起始 id,含,按 epm_id 升序翻页)。

接口路径POST /api/access_data/epmList

响应参数(data.page.records):

参数类型说明
idNumberEPM ID
snStringEPM SN
collectorIdNumber采集器 ID
collectorSnString采集器 SN
stationIdInteger电站 ID
stateInteger状态:1=在线,2=离线,3=告警
dataTimestampInteger更新时间
failSafeInteger故障保护
pEpmTotalNumberEPM 总功率
pEpmTotalStrString总功率单位
eTotalBuyNumber累计购电量
eTotalBuyStrString购电量单位
eTotalSellNumber累计售电量
eTotalSellStrString售电量单位

获取 EPM 详情

参数:sn(必填)。

接口路径POST /api/access_data/epmDetail

响应参数:列表字段 plus:

参数类型说明
empSoftwareVersionStringEPM 软件版本
pLimitNumber功率限制
ctRatioNumberCT 变比
pSetNumber功率设定
pInverterTotalNumber逆变器总功率
eToaalInverterNumber逆变器总电量
pLoadNumber总负载功率
eTotalLoadNumber总负载电量
iAc1/iAc2/iAc3Number交流电流 R/S/T
uAc1/uAc2/uAc3Number交流电压 R/S/T
pAc1/pAc2/pAc3Number有功功率 R/S/T
powerFactorNumber电网功率因数
facMeterNumber电网频率

获取 EPM 日数据

接口路径POST /api/access_data/epm/day

参数类型必填说明
snStringEPM SN
searchinfoString查询字段,逗号分隔
timeString日期,yyyy-MM-dd
timeZoneNumber电站时区

searchinfo 字段映射

searchinfo响应字段说明
u_ac1/u_ac2/u_ac3uAc1/uAc2/uAc3交流电压 U/V/W
i_ac1/i_ac2/i_ac3iAc1/iAc2/iAc3交流电流 U/V/W
p_ac1/p_ac2/p_ac3pAc1/pAc2/pAc3有功功率 U/V/W
power_factorpowerFactor电网功率因数
fac_meterfacMeter电网频率
p_loadpLoad总负载功率
e_epm_totalpEpmTotalEPM 总功率
e_total_buyeTotalBuy电网购电量
e_total_selleTotalSell电网售电量

EPM 月/年/累计数据

接口参数
EPM 月数据sn, month (yyyy-MM)
EPM 年数据sn, year (yyyy)
EPM 累计数据sn

响应参数(data 数组):

参数类型说明
dateString日期(月数据)
yearString年份(年数据)
energyNumber发电量
epmSellEnergyNumberEPM 售电量
epmBuyEnergyNumberEPM 购电量

气象仪接口详情

获取气象仪列表

参数:stationId、plantId、nmiCode、minId(起始 id,含,按 weather_id 升序翻页)。

接口路径POST /api/access_data/weatherList

响应参数(data.page.records):

参数类型说明
idNumber气象仪 ID
collectorSnString采集器 SN
nameString气象仪名称
weatherModelInteger气象仪型号:1=锦州阳光,2=锦州力成
stationIdInteger电站 ID
stateInteger状态:1=在线,2=离线,3=告警
dataTimestampInteger更新时间
totalRNumber总辐射(W/㎡)
directRNumber直射辐射
scatteredRNumber散射辐射
sunshineTimNumber日照时长(m)
totalRdayNumber日总辐射(MJ/㎡)
tempNumber温度
temperatureUnitString温度单位
humidityNumber湿度(%RH)
windDirectionString风向
windSpeedNumber风速(m/s)
airPressureNumber气压(Pa)
rainfallNumber降雨量(mm)
pvTempNumber组件温度

获取气象仪详情

参数:sn(必填)。返回同列表字段。

接口路径POST /api/access_data/weatherDetail


电站接口详情

获取电站列表

参数:plantId、nmiCode、idList(数组)、minId(起始 id,含,按 station_id 升序翻页)。

接口路径POST /api/access_data/userStationList

响应参数(data.page.records):

参数类型说明
idNumber电站 ID
stationNameString电站名称
addrString电站地址
userIdNumber用户 ID
userNameString用户名
capacityNumber装机容量
capacityStrString容量单位
fullHourNumber满发小时
latitudeNumber纬度
longitudeNumber经度
timeZoneInteger电站时区
timeZoneStrString时区描述
moneyString货币单位
priceNumber电价
powerNumber实时功率
powerStrString功率单位
dayEnergyNumber今日发电量
monthEnergyNumber月发电量
yearEnergyNumber年发电量
allEnergyNumber累计发电量
stateInteger状态:1=在线,2=离线,3=告警
dataTimestampInteger更新时间
stationTypeNewInteger电站类型
nmiCodeString澳洲发电户号
inverterPowerNumber逆变器功率
synchronizationTypeInteger同步类型
daylightSwitchInteger日光开关
timeZoneStandardIdString标准时区 ID

获取电站详情

参数:id、plantId 或 nmiCode(三选一必填)。

接口路径POST /api/access_data/stationDetail

响应参数:列表字段 plus:

参数类型说明
dayInComeNumber今日收益
monthInComeNumber月收益
yearInComeNumber年收益
allInComeNumber累计收益
batteryPowerNumber电池功率
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
batteryPercentNumber电池百分比
psumNumber总功率
gridPurchasedDayEnergyNumber今日电网购电量
gridSellDayEnergyNumber今日电网售电量
familyLoadPowerNumber家庭负载功率
homeLoadEnergyNumber家庭负载电量
inverterBatteryCapacityNumber逆变器电池容量
batteryCapacityNumber电池容量
timeZoneStandardIdString标准时区,如 Asia/Shanghai

电站日/月/年发电量列表

电站日发电量列表

参数:time(yyyy-MM-dd)、stationIds、plantId、idList、minId(起始 id,含,按 station_id 升序翻页)。

接口路径POST /api/access_data/stationDayEnergyList

响应参数(data 数组):

参数类型说明
idNumber电站 ID
energyNumber发电量
energyStrString电量单位
dateString日期
moneyNumber收益
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
gridPurchasedEnergyNumber电网购电量
gridSellEnergyNumber电网售电量
totalRKwhNumber单位面积发电量(kWh/㎡)

电站月发电量列表(10 次/秒)

参数:time(yyyy-MM)、stationIds、plantId、nmiCode、idList、minId(起始 id,含,按 station_id 升序翻页)。

接口路径POST /api/access_data/stationMonthEnergyList

响应参数(data 数组):同电站日发电量列表(energy 单位为月发电量)。

电站年发电量列表(10 次/秒)

参数:time(yyyy)、stationIds、plantId、nmiCode、idList、minId(起始 id,含,按 station_id 升序翻页)。

接口路径POST /api/access_data/stationYearEnergyList

响应参数(data 数组):同电站日发电量列表(energy 单位为年发电量)。

单个电站日/月/年/累计数据

电站日数据

参数:id、plantId 或 nmiCode(三选一必填)、money、time(yyyy-MM-dd)、timeZone。

接口路径POST /api/access_data/stationDay

响应参数(data 数组):

参数类型说明
powerNumber实时功率
timeString时间
totalRNumber瞬时辐射
batteryCapacitySocNumber电池 SOC
familyLoadPowerNumber家庭负载功率
batteryPowerNumber电池功率
psumNumber总功率

电站月数据

参数:id、plantId 或 nmiCode(三选一必填)、money、month(yyyy-MM)、timeZone。

接口路径POST /api/access_data/stationMonth

响应参数(data 数组):

参数类型说明
energyNumber发电量
dateString日期
moneyNumber收益
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
gridPurchasedEnergyNumber电网购电量
gridSellEnergyNumber电网售电量
totalRKwhNumber单位面积发电量(kWh/㎡)

电站年数据

参数:id、plantId 或 nmiCode(三选一必填)、money、year(yyyy)、timeZone。

接口路径POST /api/access_data/stationYear

响应参数(data 数组):格式同月数据。

电站累计数据

参数:id、plantId 或 nmiCode(三选一必填)、money、timeZone。

接口路径POST /api/access_data/stationAll

响应参数(data 数组):

参数类型说明
yearString年份
energyNumber累计发电量
moneyNumber累计收益
batteryDischargeEnergyNumber电池放电量
batteryChargeEnergyNumber电池充电量
gridPurchasedEnergyNumber电网购电量
gridSellEnergyNumber电网售电量
totalRKwhNumber单位面积发电量(kWh/㎡)

附录

附录 1:错误码

返回值描述
R0000无权限操作
B0001已绑定其他用户
I0003请输入 SN 号
B0049该采集器已不存在或无权限
I0000必要参数为空
B0011该用户不存在
I0012帐号或密码错误

附录 2:电站类型

返回值描述
0并网电站
1储能电站
2AC Couple 电站
3EPM 电站(并网+电表)
4内置电表(并网+电表)
5外置电表
6S5 离网并机储能
7S5 并网并机储能
8并网+AC Couple 电站
9离网储能
10S6 并网并机储能
11S6 离网并机储能

附录 3:逆变器电表类型

返回值描述
1并网
2并网加负载侧电表
3并网加电网侧电表
4储能加负载侧电表
5储能加电网侧电表
7离网储能
8并网储能双电表
1001AC Couple(不带 CT)
1002AC Couple(带 CT)

错误码参考

接口返回的 code 错误码及说明请参考 错误码