Quick Start
Welcome to the SolisCloud Developer Platform. Through the Open API, you can seamlessly integrate SolisCloud plant and device data into your own systems and applications.
API Access is by Application Only
The self-service registration feature is not yet available. All API access requests must be submitted to our sales team. Upon completion of the qualification review, you will receive your developer credentials and API access permissions.
Customer Types
API customers fall into two categories, each with a distinct onboarding process and authorization method:
| Type | Use Case | Cloud Account | Authorization |
|---|---|---|---|
| SolisCloud Users (Owners/Installers) | Hold a SolisCloud login account with directly owned or shared plants | Independent account | User-level Authorization (HMAC Signature) |
| VPP Providers / Third-parties | No SolisCloud login account; require plant owner authorization via OAuth2.0 | No account required | OAuth2.0 Authorization |
Step 1: Apply for API Access
To apply for SolisCloud Open API access, please contact our sales team to initiate the activation process. Following a qualification review, you will be issued developer credentials and the corresponding API calling permissions.
Third-party providers are also required to download, complete, and submit the application template: Application Materials for SolisCloud API Activation.xlsx, along with your activation request.
Step 2: Complete Activation — Retrieve Credentials
SolisCloud Users (Owners / Installers)
Once activation is complete, log in to the SolisCloud web portal to retrieve your API credentials:
- Log in to SolisCloud WEB:
https://www.soliscloud.com - Navigate to Service → API Management → Activate Now
- Retrieve your KeyID and KeySecret for HMAC-SHA1 signature authentication
Security Notice
Keep your KeySecret strictly confidential. In the event of a compromise, you may reset it at any time from the same page.
VPP Providers / Third-parties
Following activation, you must obtain OAuth2.0 authorization from the respective plant owners:
- Initiate an OAuth2.0 authorization request to the plant owner
- Once the owner completes authorization on SolisCloud, retrieve the Access Token for subsequent API calls
Step 3: Make API Calls
SolisCloud Users
Use your KeyID and KeySecret to generate a Custom HMAC-SHA1 signature, then call Data Access, Device Control, and other APIs accordingly.
Workflow: Obtain API Key → Generate HMAC-SHA1 Signature → Call API
VPP Providers / Third-parties
Use your OAuth2.0 Access Token to call Data Access, Device Control, and other APIs.
Workflow: Obtain Access Token → Include Bearer Token → Call API → Refresh Token
Important
User-level authorization APIs are not compatible with OAuth2.0. If OAuth2.0 is required, please use the corresponding interfaces under the OAuth2.0 authorization method.
Device Control Recommendations for Third-party Providers
Recommended Control Priority
- First choice: Use
/api/control_device/strategySettingfor dispatch command issuance (strategy-based dispatch) - If strategy dispatch does not meet your requirements, use
/api/control_device/controlas a supplementary control method - If neither approach satisfies your use case, please reach out to the integration team with your specific requirements
API Reference Table
| Customer Type | Data Access | Device Control | Plant Management | Real-time Data | Authorization |
|---|---|---|---|---|---|
| SolisCloud Users (Owner/Installer) | Data Access | Device Control | Plant Management | Real-time Forwarding | HMAC Signature |
| VPP Provider / Third-party | Data Access | Device Control | Not supported | Real-time Forwarding | OAuth2.0 |
Roadmap
Once the self-service registration feature is launched:
- Online account registration and application creation
- Full visibility of integration details through the developer portal
- Legacy
cid-based control commands will be progressively deprecated - The onboarding process will be further automated