VCOM Cloud
English German
English German

GoodWE API

Last modified:

Guideline Data logger import configuration

📗

General tips

  • Serial number: Have the data source (data logger, etc.) serial number on hand. When entering the serial number, pay attention to uppercase and lowercase letters and empty spaces.

  • Name: In most cases, the data source name can be freely selected. For recommendations, see our Naming guideline.

  • Multiple data sources: If possible, use data sources that support the same measuring interval or align the intervals if possible. Otherwise, minor features may not work properly. See also Measuring interval.

  • Automatic device creation: This will automatically create new devices in the system, such as inverters or batteries, as soon as their data is included in a new import file. It is not possible to manually create these devices. In rare exceptional cases, for example, if the devices are already included in another system, you do not need to tick this checkbox.

  • Connection test: If possible, perform a connection test once you have completed the configuration in both VCOM and the data source.

Data loggers only

  • For data loggers, update the firmware to the latest version prior to configuration.

  • For data loggers, any import that uses FTP can also use SFTP. The access data, such as the FTP server address, user name, and password remain identical. Only the port changes from port 21 (FTP) to port 2222 (SFTP).

APIs only

  • If you experience import issues with the API, please contact the respective API provider first.

  • Each day at midnight, VCOM checks for complete data and requests data from the past 7 days. If there are no limitations from the API and the data is available, the gaps will be filled.


Configuration details

Protocol

Pull via HTTPS

File format

JSON

Measuring interval

5 min

Transmission interval (pull)

5 min

User name

User name for the GoodWe SEMS portal.

Password

Password for the GoodWe SEMS portal.

Plant ID

To find the Plant ID required for VCOM, log in to the GoodWe SEMS platform and copy the alphanumeric string in the last part of the URL.

image-20250916-063506.png
Plant ID in the GoodWe SEMS platform

Configuration: API

  1. Set up your GoodWe SEMS account.

  2. Request API access from GoodWE SEMS.

📗

Tips

  • If you are using V1 of the GoodWe API, we recommend switching to V2.

  • Contact GoodWE SEMS if you require assistance with requesting or configuring the API access.

Configuration: VCOM

Prerequisites

  • User group technical customer or higher

Steps

  1. At system level , go to  icon-wrench1.png System settings > icon-database-insert.png Data sources > Data logger overview.

  2. Under New source of type, select GoodWe API as the data source type from the dropdown.

  3. Select Add.

  4. Enter the Data logger name and Data logger serial number.

  5. Select the Measuring interval.

  6. Select the Region (relevant server location).

  7. Enter the User name, Password, and Plant ID from the SEMS GoodWe platform.

  8. Select Register new data logger.

The data logger is set up.

Configure GoodWe API in VCOM
Configure GoodWe API in VCOM