Goodwe (new API)
This page explains how to connect Goodwe systems to enSights. It is for whoever manages your organization's Goodwe account and is onboarding Goodwe sites to enSights. It replaces the earlier Goodwe page, which covered only the username-and-password method.
What's new
Goodwe has moved its API to a new authentication method based on an AppKey and AppSecret instead of a username and password. enSights now supports this new Goodwe API.
- Both methods work. Existing Goodwe connections that use a username and password continue to collect data. New connections, or connections Goodwe has moved to the new method, use AppKey and AppSecret.
- The connection method is chosen per data source. Each Goodwe connection in enSights is set to either the previous (username and password) or the new (AppKey and AppSecret) connector.
- The same data either way. Daily, weekly, monthly and yearly data are mapped the same way whichever method a connection uses, so switching method does not change your reports or history.
Connection methods
Method | What you provide | When to use it |
|---|---|---|
New Goodwe API | AppKey and AppSecret issued by Goodwe | New connections, and any account Goodwe has moved to the new authentication. |
Previous Goodwe API | Username and password of an API-permitted Goodwe user | Existing connections that still work. No action needed until Goodwe retires the method for your account. |
How to
Connect Goodwe systems with the new API
- Ask Goodwe support in your region for an AppKey and AppSecret for API access to your plants. A regular Goodwe portal login is not enough.
- Ask your enSights customer success manager or support for the enSights IP addresses, and ask Goodwe to add them to the allow-list for your API access. Goodwe refuses API requests from addresses that are not on the list.
- Share the AppKey and AppSecret with enSights through the secure channel your customer success manager provides. Do not send them in plain email or chat.
- enSights sets up the connection on the new Goodwe connector and confirms once data is flowing.
Move an existing connection to the new API
- Obtain an AppKey and AppSecret from Goodwe, and have the enSights IP addresses allow-listed, as above.
- Send the new credentials to enSights and ask for the connection to be switched to the new Goodwe connector.
- Your historical data stays in place; new data continues from the new connection.
Keep using a username and password
If your existing connection is collecting data, you do not need to change anything. If you are setting up a connection with a username and password, it must belong to an API-permitted user — a user Goodwe has opened API access for, not a regular portal user. If you do not have one, ask Goodwe support in your region; you can use the proposed email to Goodwe support template.
Notes
- If the connection's credentials are rejected by Goodwe, the affected systems raise a Wrong API Credentials alert rather than No Communication. If Goodwe's servers return errors, you see Server Error. Neither means the site is offline — see API connection alerts: Server Error and Wrong API Credentials.
- A message from Goodwe saying the IP address is not on the allow-list means step 2 above is incomplete. Ask Goodwe to add the enSights addresses.
- Treat the AppKey and AppSecret like a password. Anyone who has them can read your plant data from Goodwe.