数据获取 API(用户授权)
数据获取 API 提供逆变器、采集器、EPM、气象仪、电表及电站的数据查询接口。本文档介绍面向云平台用户授权(自定义 HMAC-SHA1 签名)方式的接口调用方法。
| 项目 | 说明 |
|---|---|
| API 基础地址 | https://www.soliscloud.com:13333/ |
| 认证方式 | 自定义 HMAC-SHA1 签名 |
限流提醒
数据获取 API 接口限流为 10 次/秒。如无法满足需求,请使用队列数据转发方式(实时数据转发)。
通用响应格式
所有接口返回统一的 JSON 结构:
{
"success": true,
"code": "0",
"msg": "success",
"data": { }
}| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | true 表示成功,false 表示失败 |
| code | string | "0" 表示成功,其他表示失败(见附录) |
| msg | string | code 值的描述 |
| data | object/array | 具体业务数据 |
分页说明
数据获取接口统一使用游标分页:
| 项 | 说明 |
|---|---|
| 排序 | 固定按各接口对应的业务主键 id 升序,与各接口 minId 说明中的字段一致 |
| 首次请求 | 不传 minId,从最小 id 开始返回 |
| 继续翻页 | 传入 minId = 上一页最后一条记录的 id + 1(minId 为包含边界,传上页最后一条 id 会导致该条重复返回) |
| 单页条数 | pageSize,默认 20,最大 100 |
| 是否还有下一页 | 返回记录数等于 pageSize 说明可能还有下一页;小于 pageSize 说明已到末尾 |
| total | 固定为 0,不再返回真实总数 |
频率限制
| 接口类型 | 限制 |
|---|---|
| 数据获取接口 | 10 次/秒 |
| 设备数据上报频率 | 5 分钟 |
TIP
如果限流无法满足业务需求,请参考 实时数据转发 切换为队列数据转发。
认证方式
认证方式详见 授权方式。
请求头需携带自定义 HMAC-SHA1 签名:
| Header 参数 | 说明 |
|---|---|
| Content-MD5 | Body 内容的 MD5 值,经 Base64 编码 |
| Content-Type | application/json;charset=UTF-8 |
| Date | GMT 时间,格式:EEE, d MMM yyyy HH:mm:ss 'GMT' |
| Authorization | API {apiId}:{sign} |
接口列表
逆变器接口
| 接口 | 路径 | 说明 |
|---|---|---|
| 逆变器列表 | /v1/api/inverterList | 获取账号下逆变器列表 |
| 逆变器详情 | /v1/api/inverterDetail | 获取单台逆变器详情 |
| 逆变器日数据 | /v1/api/inverterDay | 获取单台逆变器某日实时数据 |
| 逆变器月数据 | /v1/api/inverterMonth | 获取单台逆变器某月日数据 |
| 逆变器年数据 | /v1/api/inverterYear | 获取单台逆变器某年月数据 |
| 逆变器累计数据 | /v1/api/inverterAll | 获取单台逆变器累计数据 |
| 逆变器质保数据 | /v1/api/inverter/shelfTime | 获取逆变器质保数据 |
| 报警列表 | /v1/api/alarmList | 获取设备报警列表 |
采集器接口
| 接口 | 路径 | 说明 |
|---|---|---|
| 采集器列表 | /v1/api/collectorList | 获取账号下采集器列表 |
| 采集器详情 | /v1/api/collectorDetail | 获取单台采集器详情 |
| 采集器信号值 | /v1/api/collector/day | 获取采集器信号值 |
EPM 接口
| 接口 | 路径 | 说明 |
|---|---|---|
| EPM 列表 | /v1/api/epmList | 获取账号下 EPM 列表 |
| EPM 详情 | /v1/api/epmDetail | 获取单台 EPM 详情 |
| EPM 日数据 | /v1/api/epm/day | 获取单台 EPM 某日实时数据 |
| EPM 月数据 | /v1/api/epm/month | 获取单台 EPM 某月日数据 |
| EPM 年数据 | /v1/api/epm/year | 获取单台 EPM 某年月数据 |
| EPM 累计数据 | /v1/api/epm/all | 获取单台 EPM 累计数据 |
气象仪接口
| 接口 | 路径 | 说明 |
|---|---|---|
| 气象仪列表 | /v1/api/weatherList | 获取气象仪列表 |
| 气象仪详情 | /v1/api/weatherDetail | 获取单台气象仪详情 |
电表接口(仅面向云平台用户授权)
| 接口 | 路径 | 说明 |
|---|---|---|
| 电表列表 | /v1/api/ammeterList | 获取账号下电表列表 |
| 电表详情 | /v1/api/ammeterDetail | 获取单台电表详情 |
电站接口
| 接口 | 路径 | 说明 |
|---|---|---|
| 电站列表 | /v1/api/userStationList | 获取账号下电站列表 |
| 电站详情 | /v1/api/stationDetail | 获取单个电站详情 |
| 电站日发电量列表 | /v1/api/stationDayEnergyList | 获取多个电站某日数据 |
| 电站月发电量列表 | /v1/api/stationMonthEnergyList | 获取多个电站月数据 |
| 电站年发电量列表 | /v1/api/stationYearEnergyList | 获取多个电站年数据 |
| 电站日数据 | /v1/api/stationDay | 获取单个电站某日实时数据 |
| 电站月数据 | /v1/api/stationMonth | 获取单个电站某月日数据 |
| 电站年数据 | /v1/api/stationYear | 获取单个电站某年月数据 |
| 电站累计数据 | /v1/api/stationAll | 获取某个电站累计数据 |
逆变器接口详情
获取逆变器列表
获取账号下逆变器列表,单次调用最多获取 100 台设备数据。
接口路径:POST /v1/api/inverterList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 指定电站 ID,查询该电站下逆变器 |
| plantId | String | 否 | 电站编码,可从电站列表或数据转发中获取,与 stationId 效果相同 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| snList | Array | 否 | 指定批量 SN 查询逆变器列表 |
| minId | Long | 否 | 起始 id(含),按 inverter_id 升序翻页;不传则从最小 id 开始 |
响应参数(data):
| 参数 | 类型 | 说明 |
|---|---|---|
| page | Object | 分页结果 |
| page.total | Integer | 固定为 0(游标分页不返回真实总数) |
| page.records | Array | 逆变器列表 |
| inverterStatusVo | Object | 逆变器状态统计 |
| inverterStatusVo.all | Integer | 总数量 |
| inverterStatusVo.normal | Integer | 正常数量 |
| inverterStatusVo.offline | Integer | 离线数量 |
| inverterStatusVo.fault | Integer | 故障数量 |
records 字段:
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 逆变器 ID |
| sn | String | 逆变器 SN |
| stationId | Integer | 电站 ID |
| stationName | String | 电站名称 |
| power | String | 装机容量 |
| powerStr | String | 容量单位 |
| etoday | Number | 今日发电量 |
| etodayStr | Number | 电量单位 |
| etotal | Number | 累计发电量 |
| etotalStr | Number | 总电量单位 |
| fullHour | Number | 满发小时 |
| pac | Number | 功率 |
| pacStr | Number | 功率单位 |
| state | Integer | 状态:1=在线,2=离线,3=告警 |
| dataTimestamp | Integer | 更新时间 |
| collectorSn | String | 采集器 SN |
| productModel | String | 逆变器型号 |
| dcInputType | Integer | 直流输入通道(值+1=实际) |
| acOutputType | Integer | 交流输出类型:0=单相,其他=三相 |
| inverterMeterModel | Integer | 逆变器电表类型,见附录 3 |
获取逆变器详情
接口路径:POST /v1/api/inverterDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 逆变器 ID,id 和 sn 不能同时为空 |
| sn | String | 否 | 逆变器 SN |
响应参数(data):包含列表所有字段,以及:
| 参数 | 类型 | 说明 |
|---|---|---|
| eToday/eMonth/eYear/eTotal | Number | 今日/月/年/累计发电量 |
| fac | Number | 电网频率 |
| pac | Number | 实时功率 |
| iAc1/iAc2/iAc3 | Number | 交流电流 R/S/T |
| uAc1/uAc2/uAc3 | Number | 交流电压 R/S/T |
| iPv1~iPv32 | Number | 直流电流 1~32 |
| uPv1~uPv32 | Number | 直流电压 1~32 |
| batteryCapacitySoc | Number | 电池 SOC |
| batteryPower | Number | 电池功率 |
| batteryCapacity | Number | 电池容量 |
| gridPurchasedTodayEnergy | Number | 今日电网购电量 |
| gridSellTodayEnergy | Number | 今日电网售电量 |
| familyLoadPower | Number | 家庭负载功率 |
| pSum | Number | 电网总有功功率 |
| inverterMeterModel | Integer | 电表类型,见附录 3 |
| type | Integer | 逆变器类型:1=并网,2=储能 |
| hmiVersionAll | String | HMI版本号全量 |
逆变器日/月/年/累计数据
逆变器日数据
接口路径:POST /v1/api/inverterDay
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 逆变器 ID |
| sn | String | 否 | 逆变器 SN |
| money | String | 是 | 货币单位,如 CNY |
| time | String | 是 | 日期,格式 yyyy-MM-dd |
| timeZone | Integer | 是 | 电站时区 |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| dataTimestamp | Integer | 更新时间 |
| timeStr | String | 时间字符串 |
| pac | Number | 功率 |
| eToday | Number | 今日发电量 |
| eTotal | Number | 累计发电量 |
| uPv1~uPv4 | Number | 直流电压 1~4 |
| iPv1~iPv4 | Number | 直流电流 1~4 |
| batteryCapacitySoc | Number | 电池 SOC |
| batteryPower | Number | 电池功率 |
逆变器月数据
接口路径:POST /v1/api/inverterMonth
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id/sn | - | 否 | 逆变器 ID 或 SN |
| money | String | 是 | 货币单位 |
| month | String | 是 | 月份,格式 yyyy-MM |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| energy | Number | 发电量 |
| energyStr | String | 电量单位 |
| date | String | 日期 |
| money | Number | 收益 |
| moneyStr | String | 收益单位 |
| batteryDischargeEnergy | Number | 电池放电量 |
| batteryChargeEnergy | Number | 电池充电量 |
| gridPurchasedEnergy | Number | 电网购电量 |
| gridSellEnergy | Number | 电网售电量 |
逆变器年数据
接口路径:POST /v1/api/inverterYear
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id/sn | - | 否 | 逆变器 ID 或 SN |
| money | String | 是 | 货币单位 |
| year | String | 是 | 年份,格式 yyyy |
响应参数(data 数组):同月数据。
逆变器累计数据
接口路径:POST /v1/api/inverterAll
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id/sn | - | 否 | 逆变器 ID 或 SN |
| money | String | 是 | 货币单位 |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| year | String | 年份 |
| energy | Number | 发电量 |
| batteryDischargeEnergy | Number | 电池放电量 |
| batteryChargeEnergy | Number | 电池充电量 |
| gridPurchasedEnergy | Number | 电网购电量 |
| gridSellEnergy | Number | 电网售电量 |
获取逆变器质保数据
接口路径:POST /v1/api/inverter/shelfTime
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 否 | 单个或多个 SN,逗号分隔,最多 1000 个 |
| minId | Long | 否 | 起始 id(含),按 id 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 逆变器 ID |
| sn | String | 逆变器 SN |
| shelfBeginTime | String | 质保开始时间 |
| shelfEndTime | String | 质保结束时间 |
| shelfTime | String | 质保时长 |
| shelfState | Integer | 质保状态:0=质保中,1=已过期 |
获取报警列表
接口路径:POST /v1/api/alarmList
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 电站 ID |
| plantId | String | 否 | 电站编码,与 stationId 效果相同 |
| alarmDeviceSn | String | 否 | 逆变器 SN |
| alarmBeginTime | String | 否 | 开始日期,yyyy-MM-dd |
| alarmEndTime | String | 否 | 结束日期,yyyy-MM-dd |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| State | Integer | 否 | 0=未处理,1=已处理,2=已恢复 |
| minId | Long | 否 | 起始 id(含),按 alarmId 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| stationId | Integer | 电站 ID |
| stationName | String | 电站名称 |
| alarmDeviceSn | String | 告警设备 SN |
| alarmCode | String | 告警码 |
| alarmLevel | Integer | 告警级别:1=提示,2=一般,3=紧急 |
| alarmBeginTime | String | 告警开始时间 |
| alarmEndTime | String | 告警结束时间 |
| alarmMsg | String | 告警信息 |
| advice | String | 处理建议 |
| state | Integer | 状态:0=未处理,1=已处理,2=已恢复 |
| warningInfoData | Object | 告警扩展数据 |
采集器接口详情
获取采集器列表
获取账号下采集器列表,单次调用最多获取 100 台设备数据。
接口路径:POST /v1/api/collectorList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 指定电站 ID |
| plantId | String | 否 | 电站编码,与 stationId 效果相同 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| minId | Long | 否 | 起始 id(含),按 collector_id 升序翻页;不传则从最小 id 开始 |
响应参数(data):
| 参数 | 类型 | 说明 |
|---|---|---|
| page | Object | 分页结果 |
| page.total | Integer | 固定为 0(游标分页不返回真实总数) |
| page.records | Array | 采集器列表 |
| collectionStatusVo | Object | 采集器状态统计 |
| collectionStatusVo.all | Integer | 总数量 |
| collectionStatusVo.normal | Integer | 正常数量 |
| collectionStatusVo.offline | Integer | 离线数量 |
| collectionStatusVo.fault | Integer | 故障数量 |
records 字段:
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 采集器 ID |
| sn | String | 采集器 SN |
| stationId | Integer | 电站 ID |
| stationName | String | 电站名称 |
| model | String | 采集器型号 |
| name | String | 采集器名称 |
| rssiLevel | Integer | 信号强度等级 |
| state | Integer | 状态:1=在线,2=离线,3=告警 |
| dataTimestamp | Integer | 数据更新时间戳 |
| contractTime | String | 到期时间 |
获取采集器详情
接口路径:POST /v1/api/collectorDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 采集器 ID,id 和 sn 不能同时为空 |
| sn | String | 否 | 采集器 SN |
响应参数(data):包含列表所有字段,以及:
| 参数 | 类型 | 说明 |
|---|---|---|
| maximumNumber | Integer | 最大接入设备数 |
| actualNumber | Integer | 实际接入设备数 |
| currentWorkingTime | Integer | 当前运行时长 |
| totalWorkingTime | Integer | 总运行时长 |
| dataUploadCycle | Integer | 数据上报周期(秒) |
| factoryTime | String | 出厂时间 |
获取采集器信号值
接口路径:POST /v1/api/collector/day
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | 采集器 SN |
| time | String | 是 | 日期,格式 yyyy-MM-dd |
| timeZone | Integer | 是 | 电站时区 |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| collectorId | Number | 采集器 ID |
| collectorSn | String | 采集器 SN |
| dataTimestamp | Integer | 数据时间戳 |
| timeStr | String | 时间字符串 |
| pec | Number | 信号质量(%) |
| rssi | Number | 接收信号强度 |
| rssiLevel | Integer | 信号等级 |
EPM 接口详情
获取 EPM 列表
获取账号下 EPM 列表,单次调用最多获取 100 台设备数据。
接口路径:POST /v1/api/epmList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 指定电站 ID |
| plantId | String | 否 | 电站编码,与 stationId 效果相同 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| minId | Long | 否 | 起始 id(含),按 epm_id 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | EPM ID |
| sn | String | EPM SN |
| collectorId | Number | 采集器 ID |
| collectorSn | String | 采集器 SN |
| stationId | Integer | 电站 ID |
| state | Integer | 状态:1=在线,2=离线,3=告警 |
| dataTimestamp | Integer | 数据更新时间戳 |
| failSafe | Integer | 故障保护状态 |
| pEpmTotal | Number | EPM 总功率 |
| pEpmTotalStr | String | 功率单位 |
| eTotalBuy | Number | 电网总购电量 |
| eTotalBuyStr | String | 购电量单位 |
| eTotalSell | Number | 电网总售电量 |
| eTotalSellStr | String | 售电量单位 |
获取 EPM 详情
接口路径:POST /v1/api/epmDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | EPM SN |
响应参数(data):包含列表所有字段,以及:
| 参数 | 类型 | 说明 |
|---|---|---|
| empSoftwareVersion | String | EPM 固件版本 |
| pLimit | Number | 功率限制 |
| ctRatio | Number | CT 变比 |
| pSet | Number | 功率设定值 |
| pInverterTotal | Number | 逆变器总功率 |
| eToaalInverter | Number | 逆变器总电量 |
| pLoad | Number | 负载功率 |
| eTotalLoad | Number | 负载总电量 |
| iAc1 / iAc2 / iAc3 | Number | 交流电流 U/V/W(A) |
| uAc1 / uAc2 / uAc3 | Number | 交流电压 U/V/W(V) |
| pAc1 / pAc2 / pAc3 | Number | 有功功率 U/V/W(W) |
| powerFactor | Number | 电网功率因数 |
| facMeter | Number | 电网频率(Hz) |
获取 EPM 日数据
接口路径:POST /v1/api/epm/day
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | EPM SN |
| searchinfo | String | 是 | 查询字段,逗号分隔 |
| time | String | 是 | 日期,yyyy-MM-dd |
| timeZone | Number | 是 | 电站时区 |
searchinfo 字段映射:
| searchinfo | 响应字段 | 说明 |
|---|---|---|
| u_ac1/u_ac2/u_ac3 | uAc1/uAc2/uAc3 | 交流电压 U/V/W |
| i_ac1/i_ac2/i_ac3 | iAc1/iAc2/iAc3 | 交流电流 U/V/W |
| p_ac1/p_ac2/p_ac3 | pAc1/pAc2/pAc3 | 有功功率 U/V/W |
| power_factor | powerFactor | 电网功率因数 |
| fac_meter | facMeter | 电网频率 |
| p_load | pLoad | 总负载功率 |
| e_epm_total | pEpmTotal | EPM 总功率 |
| e_total_buy | eTotalBuy | 电网购电量 |
| e_total_sell | eTotalSell | 电网售电量 |
EPM 月数据
接口路径:POST /v1/api/epm/month
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | EPM SN |
| month | String | 是 | 月份,格式 yyyy-MM |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| date | String | 日期 |
| energy | Number | 发电量 |
| epmSellEnergy | Number | 售电量 |
| epmBuyEnergy | Number | 购电量 |
EPM 年数据
接口路径:POST /v1/api/epm/year
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | EPM SN |
| year | String | 是 | 年份,格式 yyyy |
响应参数(data 数组):同月数据字段。
EPM 累计数据
接口路径:POST /v1/api/epm/all
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | EPM SN |
响应参数(data):
| 参数 | 类型 | 说明 |
|---|---|---|
| energy | Number | 累计发电量 |
| epmSellEnergy | Number | 累计售电量 |
| epmBuyEnergy | Number | 累计购电量 |
气象仪接口详情
获取气象仪列表
获取账号下气象仪列表。
接口路径:POST /v1/api/weatherList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 指定电站 ID |
| plantId | String | 否 | 电站编码,与 stationId 效果相同 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| minId | Long | 否 | 起始 id(含),按 weather_id 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 气象仪 ID |
| collectorSn | String | 采集器 SN |
| name | String | 气象仪名称 |
| weatherModel | Integer | 气象仪型号:1=锦州阳光,2=锦州力成 |
| stationId | Integer | 电站 ID |
| state | Integer | 状态:1=在线,2=离线 |
| dataTimestamp | Integer | 数据更新时间戳 |
| totalR | Number | 总辐射(W/㎡) |
| directR | Number | 直接辐射 |
| scatteredR | Number | 散射辐射 |
| sunshineTim | Number | 日照时长(分钟) |
| totalRday | Number | 日总辐射(MJ/㎡) |
| temp | Number | 环境温度 |
| temperatureUnit | String | 温度单位 |
| humidity | Number | 湿度(%RH) |
| windDirection | String | 风向 |
| windSpeed | Number | 风速(m/s) |
| airPressure | Number | 气压(Pa) |
| rainfall | Number | 降雨量(mm) |
| pvTemp | Number | 组件温度 |
获取气象仪详情
接口路径:POST /v1/api/weatherDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | 气象仪 SN |
响应参数(data):同列表字段。
电表接口详情(仅面向云平台用户授权)
获取电表列表
获取账号下电表列表。
接口路径:POST /v1/api/ammeterList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stationId | Integer | 否 | 指定电站 ID |
| plantId | String | 否 | 电站编码,与 stationId 效果相同 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| minId | Long | 否 | 起始 id(含),按 ammeter_id 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 电表 ID |
| sn | String | 电表 SN |
| collectorId | Number | 采集器 ID |
| collectorSn | String | 采集器 SN |
| name | String | 电表名称 |
| stationId | Integer | 电站 ID |
| state | Integer | 状态:1=在线,2=离线 |
| dataTimestamp | Integer | 数据更新时间戳 |
| psum | Number | 总有功功率 |
| psumStr | String | 功率单位 |
| eTodayPositiveActive | Number | 今日正向有功电量 |
| eTodayReverseActive | Number | 今日反向有功电量 |
| eTotalPositiveActive | Number | 累计正向有功电量 |
| eTotalReverseActive | Number | 累计反向有功电量 |
获取电表详情
接口路径:POST /v1/api/ammeterDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sn | String | 是 | 电表 SN |
响应参数(data):包含列表所有字段,以及:
| 参数 | 类型 | 说明 |
|---|---|---|
| currentTransformer | Number | 电流互感器变比 |
| electricMeter | Integer | 电表类型:0=单相,其他=三相 |
| pA / pB / pC | Number | A/B/C 相有功功率(W) |
| aReactivePower / bReactivePower / cReactivePower | Number | A/B/C 相无功功率(Var) |
| aLookedPower / bLookedPower / cLookedPower | Number | A/B/C 相视在功率(VA) |
| uA / uB / uC | Number | A/B/C 相电压(V) |
| iA / iB / iC | Number | A/B/C 相电流(A) |
| totalReactivePower | Number | 总无功功率 |
| totalViewPower | Number | 总视在功率 |
| fAc | Number | 电网频率(Hz) |
| averagePowerFactor | Number | 平均功率因数 |
电站接口详情
获取电站列表
获取账号下电站列表。
接口路径:POST /v1/api/userStationList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI),澳大利亚地区专用 |
| idList | Array | 否 | 电站 ID 列表,批量查询 |
| minId | Long | 否 | 起始 id(含),按 station_id 升序翻页;不传则从最小 id 开始 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 电站 ID |
| stationName | String | 电站名称 |
| addr | String | 电站地址 |
| userId | Number | 用户 ID |
| userName | String | 用户名称 |
| capacity | Number | 装机容量 |
| capacityStr | String | 容量单位 |
| fullHour | Number | 满发小时 |
| latitude | String | 纬度 |
| longitude | String | 经度 |
| timeZone | Integer | 时区 |
| timeZoneStr | String | 时区描述 |
| money | String | 货币单位 |
| price | Number | 电价 |
| power | Number | 实时功率 |
| powerStr | String | 功率单位 |
| dayEnergy | Number | 今日发电量 |
| monthEnergy | Number | 本月发电量 |
| yearEnergy | Number | 本年发电量 |
| allEnergy | Number | 累计发电量 |
| state | Integer | 状态 |
| dataTimestamp | Integer | 数据更新时间戳 |
| stationTypeNew | Integer | 电站类型,见附录 2 |
| nmiCode | String | 澳洲发电户号 |
| inverterPower | Number | 逆变器功率 |
| synchronizationType | Integer | 并网类型 |
| daylightSwitch | Integer | 日光开关 |
| timeZoneStandardId | String | 标准时区,如 Asia/Shanghai |
获取电站详情
接口路径:POST /v1/api/stationDetail
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 电站 ID,id、plantId、nmiCode 三选一 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
响应参数(data):包含列表所有字段,以及:
| 参数 | 类型 | 说明 |
|---|---|---|
| dayInCome | Number | 今日收益 |
| monthInCome | Number | 本月收益 |
| yearInCome | Number | 本年收益 |
| allInCome | Number | 累计收益 |
| batteryPower | Number | 电池功率 |
| batteryDischargeEnergy | Number | 电池放电量 |
| batteryChargeEnergy | Number | 电池充电量 |
| batteryPercent | Number | 电池电量百分比 |
| psum | Number | 电网总有功功率 |
| gridPurchasedDayEnergy | Number | 今日电网购电量 |
| gridSellDayEnergy | Number | 今日电网售电量 |
| familyLoadPower | Number | 家庭负载功率 |
| homeLoadEnergy | Number | 家庭负载电量 |
| inverterBatteryCapacity | Number | 电池容量 |
| batteryCapacity | Number | 电池容量 |
| timeZoneStandardId | String | 标准时区,如 Asia/Shanghai |
电站日发电量列表
获取多个电站某日发电量数据。
接口路径:POST /v1/api/stationDayEnergyList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| time | String | 是 | 日期,格式 yyyy-MM-dd |
| stationIds | String | 否 | 电站 ID,逗号分隔 |
| plantId | String | 否 | 电站编码 |
| idList | Array | 否 | 电站 ID 列表 |
| minId | Long | 否 | 起始 id(含),按 station_id 升序翻页;不传则从最小 id 开始 |
| beginTime | String | 否 | 查询开始时间,格式:yyyy-MM-dd,不传默认最近30天 |
| endTime | String | 否 | 查询结束时间,格式:yyyy-MM-dd,不传默认今天 |
响应参数(data.page.records):
| 参数 | 类型 | 说明 |
|---|---|---|
| id | Number | 电站 ID |
| energy | Number | 发电量 |
| energyStr | String | 电量单位 |
| date | String | 日期 |
| money | Number | 收益 |
| batteryDischargeEnergy | Number | 电池放电量 |
| batteryChargeEnergy | Number | 电池充电量 |
| gridPurchasedEnergy | Number | 电网购电量 |
| gridSellEnergy | Number | 电网售电量 |
| totalRKwh | Number | 单位面积辐射量(kWh/㎡) |
电站月发电量列表
获取多个电站某月发电量数据。限流:10 次/秒。
接口路径:POST /v1/api/stationMonthEnergyList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| time | String | 是 | 月份,格式 yyyy-MM |
| stationIds | String | 否 | 电站 ID,逗号分隔 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
| idList | Array | 否 | 电站 ID 列表 |
| minId | Long | 否 | 起始 id(含),按 station_id 升序翻页;不传则从最小 id 开始 |
响应参数:同日发电量列表字段。
电站年发电量列表
获取多个电站某年发电量数据。限流:10 次/秒。
接口路径:POST /v1/api/stationYearEnergyList
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| time | String | 是 | 年份,格式 yyyy |
| stationIds | String | 否 | 电站 ID,逗号分隔 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
| idList | Array | 否 | 电站 ID 列表 |
| minId | Long | 否 | 起始 id(含),按 station_id 升序翻页;不传则从最小 id 开始 |
响应参数:同日发电量列表字段。
电站日数据
获取单个电站某日实时数据。
接口路径:POST /v1/api/stationDay
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 电站 ID,id、plantId、nmiCode 三选一 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
| money | String | 是 | 货币单位,如 CNY |
| time | String | 是 | 日期,格式 yyyy-MM-dd |
| timeZone | Integer | 是 | 电站时区 |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| power | Number | 功率 |
| time | String | 时间点 |
| totalR | Number | 瞬时辐射 |
| batteryCapacitySoc | Number | 电池 SOC(%) |
| familyLoadPower | Number | 家庭负载功率 |
| batteryPower | Number | 电池功率 |
| psum | Number | 电网总有功功率 |
电站月数据
接口路径:POST /v1/api/stationMonth
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 电站 ID,三选一 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
| money | String | 是 | 货币单位 |
| month | String | 是 | 月份,格式 yyyy-MM |
| timeZone | Integer | 是 | 电站时区 |
响应参数(data 数组):
| 参数 | 类型 | 说明 |
|---|---|---|
| energy | Number | 发电量 |
| date | String | 日期 |
| money | Number | 收益 |
| batteryDischargeEnergy | Number | 电池放电量 |
| batteryChargeEnergy | Number | 电池充电量 |
| gridPurchasedEnergy | Number | 电网购电量 |
| gridSellEnergy | Number | 电网售电量 |
| totalRKwh | Number | 单位面积辐射量(kWh/㎡) |
电站年数据
参数同月数据,用 year(格式 yyyy)替代 month。响应字段同月数据。
接口路径:POST /v1/api/stationYear
电站累计数据
接口路径:POST /v1/api/stationAll
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 电站 ID,三选一 |
| plantId | String | 否 | 电站编码 |
| nmiCode | String | 否 | 澳洲发电户号(NMI) |
| money | String | 是 | 货币单位 |
| timeZone | Integer | 是 | 电站时区 |
响应参数(data):
| 参数 | 类型 | 说明 |
|---|---|---|
| year | String | 年份 |
| energy | Number | 累计发电量 |
| money | Number | 累计收益 |
| batteryDischargeEnergy | Number | 电池累计放电量 |
| batteryChargeEnergy | Number | 电池累计充电量 |
| gridPurchasedEnergy | Number | 电网累计购电量 |
| gridSellEnergy | Number | 电网累计售电量 |
| totalRKwh | Number | 累计单位面积辐射量(kWh/㎡) |
附录
附录 1:错误码
| 返回值 | 描述 |
|---|---|
| R0000 | 无权限操作 |
| B0001 | 已绑定其他用户 |
| I0003 | 请输入 SN 号 |
| B0049 | 该采集器已不存在或无权限 |
| I0000 | 必要参数为空 |
| B0011 | 该用户不存在 |
| I0012 | 帐号或密码错误 |
附录 2:电站类型
| 返回值 | 描述 |
|---|---|
| 0 | 并网电站 |
| 1 | 储能电站 |
| 2 | AC Couple 电站 |
| 3 | EPM 电站(并网+电表) |
| 4 | 内置电表(并网+电表) |
| 5 | 外置电表 |
| 6 | S5 离网并机储能 |
| 7 | S5 并网并机储能 |
| 8 | 并网+AC Couple 电站 |
| 9 | 离网储能 |
| 10 | S6 并网并机储能 |
| 11 | S6 离网并机储能 |
附录 3:逆变器电表类型
| 返回值 | 描述 |
|---|---|
| 1 | 并网 |
| 2 | 并网加负载侧电表 |
| 3 | 并网加电网侧电表 |
| 4 | 储能加负载侧电表 |
| 5 | 储能加电网侧电表 |
| 7 | 离网储能 |
| 8 | 并网储能双电表 |
| 1001 | AC Couple(不带 CT) |
| 1002 | AC Couple(带 CT) |
错误码参考
接口返回的 code 错误码及说明请参考 错误码。
