Catalog API access and Solargis Evaluate connection

Prev Next

In this document

You'll learn how to integrate PVCC via API and connect it to Solargis Evaluate: generating an admin-only API key (Company management → API Access, shown only once at creation), and how public catalog components work automatically in Evaluate while private/unpublished components require pasting the API key into Evaluate's Company administration → Integration → PVcomponents.com settings. Also covers monitoring catalog/Evaluate connection usage under the company admin Usage section.

Prerequisites

  • An active Solargis PV components catalog account.

  • An active Solargis Evaluate account (for integration).

  • Admin access to both, for editing purposes.

PV components catalog API integration

PV components catalog offers robust API integration to retrieve component data via API for use in various applications (e.g., Solargis Evaluate).

You can use several endpoints to call for various component data based on your requirements. For full technical details of the API integration, see API documentation.

Connecting the catalog to Solargis Evaluate

If you already have Solargis Evaluate subscription, you can connect it to your PVCC account. To establish connection between your Solargis Evaluate and PVCC accounts, see Integrations. Once connected, you can use your private catalog components in your PV energy system designs.

If you do not have Solargis Evaluate subscription, contact our sales team.

Generating the API key for 3rd party connection

If you want to access the catalog and your private components via 3rd party application, you need to generate an API key to establish the connection. To connect your 3rd party application to the PV components catalog, you must generate an API key.

Key points to remember:

  • You can have multiple API keys for use in different applications.

  • Older API keys can not be deactivated, only deleted if the usage is no longer required.

  • API key is shown only once upon its creation for security reasons. If you do not save it, you will have to generate a new one.

To generate an API key, navigate to the Company management page from the main menu and proceed with the following steps:

  1. Switch to the API Access section.

  2. Click the “Create new key” button to generate the key.

The new API key will show in the pop-up window. Copy and save the key. It is displayed only once, and you will not be able to retrieve it again after closing the pop-up. Now you can use it in your 3rd party application to connect to your PVCC account and access your custom components.

Once the API key is added to the API access page, you can change the key’s description using the pen icon for custom identification (e.g., where it is used).

Usage tracking

You can view your catalog/Evaluate connection usage and remaining limits in the company admin section under Usage.