API integration and Solargis Evaluate connection

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 call several endpoints to call for various component data based on your requirements.

Prerequisites to API integration

To connect to the catalog and download component data, the following conditions must be met:

• You must have an active PV components catalog account.

• You will need to generate an API key (token) for authorisation.

Note: You can find full technical details of the API integration in our API documentation.

Generating the API key

Important: This procedure is available to admin users only.

When generating the key for the first time:

1. Navigate to the My company/API access page.

2. Generate your key using the “Create new key” button. The key will be generated and presented to you in a popup. Copy the key to the clipboard and enter it into your application.

Important: Save the key for future reference as it will not be shown again due to confidence and safety reasons. If you lose it, you will have to generate a new one and replace it in your application.

Regenerating your key

If you lost your API key and need one again, you can regenerate it.

1. Navigate to the My company/API access page. Beware that the previous key will no longer be valid once you generate a new one. You will need to replace it with the new key in your application to enable the integration again.

2. Click the “Regenerate key” button to create a new key. Proceed in the pop-up dialog and store the key. It will not be shown again.

You can now use the API key in your application to communicate with the PV components catalog.

Connecting catalog to Solargis Evaluate

Video guide on how to connect the catalog to the Solargis Evaluate application.

Catalog components in Evaluate

You can use all public catalog components in Solargis Evaluate without performing any additional steps. Public catalog components are available to all Evaluate users by default.

However, if you have components in your catalog that are unpublished or you want to use them privately in your designs, you need to connect your catalog account to the Solargis Evaluate application.

Important: This procedure is available to admin users only.

You will need an API key to connect the catalog with the Solargis Evaluate. Obtain one as described in the Generating the API key section above.

Adding the API key to Evaluate

Once you have obtained your API key, you must copy it to your Solargis Evaluate account:

1. In the Evaluate application, go to Company administration / Integration / PVcomponents.com / Manage.

2. Paste the PVCC key to the Private API key field.

3. Hit the “Save and Close” button to save it.

Usage tracking

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