SolisCloud API 1.0.8
SolisCloud API 1.0.8
V1.0.8
Check: Date:
Approve: Date:
Revision History
2
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 3 / 41 Eff Date: 2019年08月01日
Content
1. INTRODUCTION......................................................................................................................................... 5
3. API INTERFACE.........................................................................................................................................11
3
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 4 / 41 Eff Date: 2019年08月01日
4
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 5 / 41 Eff Date: 2019年08月01日
1. INTRODUCTION
This document describes the third party using Soliscloud interface definition. A third party can use the
provided ports to get corresponding information of the PV plants.
1.1. Port Access Method
All interfaces involved in this document use HTTP POST, and message transmission is in JSON format.
Different capabilities support different access protocols and message formats. When external systems
access the SolisCloud platform, they need to select the corresponding access protocol and message
format.
1.2. Request url
Please contact Solis tech support
1.3. Public HTTP Header Definition
1.3.1. Public Request Header
Some public request headers are used in the interface. These request headers can be used by all
requests and are defined in detail as follows
Name Type Default Note
Authorization String - Authentication information used to
verify the validity of the request.
Content-MD5 String - Represents the MD5 value of the
requested content data, calculates the
MD5 value of the message content
(excluding the header) to obtain a
128-bit number, and then base64
encodes the number.
Content-Type String application/json;charset=UTF-8 HTTP request content type.
Only support application/json
Date String - The GMT time specified in the HTTP
1.1 protocol, for example: Wed, 05
Sep. 2019 23:00:00 GMT
5
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 6 / 41 Eff Date: 2019年08月01日
6
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 7 / 41 Eff Date: 2019年08月01日
7
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 8 / 41 Eff Date: 2019年08月01日
/**
* Description: 获取 GMTTime
* @return 将当前 Time 转换为 GMT 时区后的 String
*/
public static String getGMTTime(){
Calendar cd = Calendar.getInstance();
SimpleDateFormat sdf = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss
'GMT'", Locale.US);
sdf.setTimeZone(TimeZone.getTimeZone("GMT")); // 设置时区为 GMT
String str = sdf.format(cd.getTime());
return str;
}
8
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 9 / 41 Eff Date: 2019年08月01日
Then add the Authorization header to form the final message that needs to be sent:
POST /v1/api/userStationList
Content-MD5: mBAcWORUK93FBOz6jsAuqw==
Content-Type: application/json
Date: Fri, 26 Jul 2019 06:00:46 GMT
Authorization: API 2424:/2Np3q5h846q9cWEFUNtbL+G7H8=
{"userId":"1145611319416590338"}
2.3. Add user password encryption
MD5 encryption for password, JAVA code example:
public static String md5(String sourceStr) {
String result = "";
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(sourceStr.getBytes());
byte[] b = md.digest();
int i;
StringBuffer buf = new StringBuffer("");
for (int offset = 0; offset < b.length; offset++) {
i = b[offset];
if (i < 0) {
9
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 10 / 41 Eff Date: 2019年08月01日
i += 256;
}
if (i < 16) {
buf.append("0");
}
buf.append(Integer.toHexString(i));
}
result = buf.toString();
} catch (Exception e) {
System.out.println(e);
}
return result;
}
10
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 11 / 41 Eff Date: 2019年08月01日
3. API INTERFACE
3.1. /v1/api/userStationList Power Station List
3.1.1. Input parameters
Name Type Description Note
pageNo Int Current page number Specify the number of response
pages to be returned. The value
defaults to 1
pageSize Int Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
userId Long User id If send the value, check the user’s
plant, if not send, check all plants
11
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 12 / 41 Eff Date: 2019年08月01日
Today Generation
dayEnergyStr unit
allEnergy Total Generation
Total Generation
allEnergyStr Unit
fullHour Peak Hours
picName Picture
power Power
powerStr Power Unit
latitude String latitude
longitude String longitude
installerId Main account id
installer Main account
1:Online 2:Offline 3:Alarm
state Power station status
Power station update
dataTimestamp Long time Timestamp
12
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 13 / 41 Eff Date: 2019年08月01日
13
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 14 / 41 Eff Date: 2019年08月01日
14
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 15 / 41 Eff Date: 2019年08月01日
energy
Meter this month sell
gridSellMonthEnergyStr energy unit
Meter this year sell
gridSellYearEnergy energy
Meter this year sell
gridSellYearEnergyStr energy unit
gridSellTotalEnergy Meter total sell energy
Meter total sell energy
gridSellTotalEnergyStr unit
familyLoadPower Load power
familyLoadPowerStr Load power unit
familyLoadPowerPec Load powerPercentage
homeLoadEnergy Today load energy
homeLoadEnergyStr Today load energy unit
15
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 16 / 41 Eff Date: 2019年08月01日
16
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 17 / 41 Eff Date: 2019年08月01日
lanIp LAN ip
mac Mac address
Maximum number
maximumNumber of connected units
Actual number of
actualNumber connected units
connectedSsid Connected ssid
connectionOperator Operator
Working time of this
currentWorkingTime power-on
Cumulative working
totalWorkingTime time
dataUploadCycle Data upload interval
factoryTime Factory time
gprsEndTime Package end time
3.5. /v1/api/inveterList Inverter List
3.5.1. Input parameters
Name Type Description Note
pageNo String Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize String Number per page Specify the number of records
returned in each response page.
The default value is 20, max 100
stationId Long Power station id Without: Check all under the
installer.
With: Check the indicated plant
3.5.2. Output Parameters
Name Type Description Note
page - Result list
inverterStatusVo - Number of results
total Long Total list
records List<> List
Total number of
all Int power stations
Number of normal
normal Int power stations
Number of offline
offline Int stations
17
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 18 / 41 Eff Date: 2019年08月01日
Number of failed
fault Int power stations
id Long Inverter id
sn String Inverter SN
stationId Long Power station id
stationName String Plant name
userId Long Owner Id
power String Installed capacity
Installed capacity
powerStr String unit
etoday Energy of the day
Energy unit of the
etodayStr day
etotal Total energy
etotalStr Total energy unit
fullHour Peak Hours
picName image
pac power
pacStr Power unit
state Power station status 1:Online 2:Offline 3:Alarm
Power station update
dataTimestamp time Timestamp
18
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 19 / 41 Eff Date: 2019年08月01日
19
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 20 / 41 Eff Date: 2019年08月01日
20
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 21 / 41 Eff Date: 2019年08月01日
21
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 22 / 41 Eff Date: 2019年08月01日
22
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 23 / 41 Eff Date: 2019年08月01日
3.7. /v1/api/addUser New User (Create if not exists; if exists, return userId)
3.7.1. Input parameters
Name Type Description Note
userName String username
password String password
email String mailbox Can be empty
mobile String phone number Can be empty
userType Integer user level Ordinary users pass 0
23
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 24 / 41 Eff Date: 2019年08月01日
24
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 25 / 41 Eff Date: 2019年08月01日
25
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 26 / 41 Eff Date: 2019年08月01日
energy
batteryChargeEn Battery
ergy charge
energy
gridPurchasedEn Meter
ergy purchase
energy
gridSellEnergy Meter sell
energy
3.12. /v1/api/stationAll Plant cumulative graph
3.12.1. Input parameters
Name Type Description Note
id Long Power station id
money String Power plant
currency unit
26
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 27 / 41 Eff Date: 2019年08月01日
27
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 28 / 41 Eff Date: 2019年08月01日
28
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 29 / 41 Eff Date: 2019年08月01日
Energy discharge
energy
batteryChargeEn Battery
ergy charge
energy
gridPurchasedEn Meter
ergy purchase
energy
gridSellEnergy Meter sell
energy
3.17. /v1/api/inverterAll Inverter Cumulative Graph
3.17.1. Input parameters
Name Type Description Note
id Long Inverter id Id or SN
sn String Inverter sn Id or SN
money String Power plant
currency unit
3.17.2. Output Parameters
Name Type Description Note
energy Long Power generation
energyStr String Power generation
unit
money Long income
moneyStr String Income unit
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge
ergy energy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy
29
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 30 / 41 Eff Date: 2019年08月01日
30
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 31 / 41 Eff Date: 2019年08月01日
31
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 32 / 41 Eff Date: 2019年08月01日
32
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 33 / 41 Eff Date: 2019年08月01日
33
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 34 / 41 Eff Date: 2019年08月01日
34
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 35 / 41 Eff Date: 2019年08月01日
35
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 36 / 41 Eff Date: 2019年08月01日
36
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 37 / 41 Eff Date: 2019年08月01日
37
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 38 / 41 Eff Date: 2019年08月01日
38
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 39 / 41 Eff Date: 2019年08月01日
Today battery
batteryTodayDischar discharge energy
geEnergyStr unit
This month battery
batteryMonthDischa discharge energy
rgeEnergy
This month battery
batteryMonthDischa discharge energy
rgeEnergyStr unit
This year battery
batteryYearDischarg discharge energy
eEnergy
This year battery
batteryYearDischarg discharge energy
eEnergyStr unit
Total battery
batteryTotalDischarg discharge energy
eEnergy
Total battery
batteryTotalDischarg discharge energy
eEnergyStr unit
39
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 40 / 41 Eff Date: 2019年08月01日
y energy
gridSellTodayEnerg Today meter sell
yStr energy unit
gridSellMonthEnerg This month meter
y sell energy
gridSellMonthEnerg This month meter
yStr sell energy unit
This year meter sell
gridSellYearEnergy energy
gridSellYearEnergyS This year meter sell
tr energy unit
Total meter sell
gridSellTotalEnergy energy
gridSellTotalEnergy Total meter sell
Str energy unit
HouseLoad power
familyLoadPower
HouseLoad power
familyLoadPowerStr unit
BackupLoad power
bypassLoadPower
bypassLoadPowerSt BackupLoad power
r unit
Grid total active
pSum power
Grid total active
pSumStr power unit
psumPec Grid total active
powerPercentage
homeLoadTodayEne Today load energy
rgy
homeLoadTodayEne Today load energy
rgyStr unit
homeLoadTotalEner
gy Total load energy
homeLoadTotalEner Total load energy
gyStr unit
3.26. /v1/api/stationDayEnergyList Batch acquire plant day Generation
3.26.1. Input parameters
40
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 41 / 41 Eff Date: 2019年08月01日
41
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 42 / 41 Eff Date: 2019年08月01日
42