VCOM Cloud

SMA API

Last modified:

Set up SMA API

📗

General tips

  • 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.

  • The data source name can be freely selected. For recommendations, see our Naming guideline.

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

  • We strongly recommend ticking the check box Automatic device creation to ensure that VCOM automatically creates any new devices found during each data import.

  • 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

HTTPS Pull

File format

JSON

Transmission interval (pull)

hourly

Server

ftp.sspcdn-a.net

Port

21

Client ID

Refer to manufacturer documentation

Client secret

Refer to manufacturer documentation

Plant ID

  • In the Sunny Portal powered by ennexOS UI, the Monitoring API plant and device IDs are part of the URL when navigating to the corresponding plant/device.

    Plant ID with Sunny Portal ennexOS


  • In the Sunny Portal classic UI, the Monitoring API plant ID is part of the URL when clicking on the PV System Logbook navigation tree item. The Monitoring API device IDs are not displayed on the Sunny Portal UI.

Plant ID with Sunny Portal
Plant ID with Sunny Portal

Configuration: API

Allow your plant to access the API.

SMA API Allow plant access to API
SMA API: Allow plant access to API

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 SMA API as the data source type from the dropdown.

  3. Select Add.

  4. Fill in required input fields.

  5. Select Register new data logger.

image-20260807-133745.png