Integration setup - get the TMY requestId

In this guide, we will provide information about how to set up the TMY data API integration to obtain the requestId required for obtaining the location data. The endpoint provided here is for integration purposes only and does not allow you to download location data from your live Solargis account.

Once you obtain the integration requestId, you can proceed to get the sample location data to understand the response.

Key points to remember before you proceed:

• Our Sales team must create an integration account for you. Contact them if you do not have one already.

• This integration endpoint shows how to set up the API request for TMY Basic and TMY Pro subscriptions to obtain the requestId. 

• You will need to generate an API token to authenticate calls to the integration account.

• Calls to the integration API endpoints are free of charge.

• You can test the endpoint in the API console to the right. Learn how to use the console in the Using the API console guide. 

• The request parameters can not be changed for the API integration call to work. Amending the request parameters will result in an error.

TMY integration endpoints

There is a separate integration testing request for every subscription (TMY Basic and TMY Pro).

Key parameters of the requests are:

• The endpoint URL is identical for both requests.

• API tokens are generated separately for TMY Basic and TMY Pro integrations.

• The body parameters differ for TMY Basic and TMY Pro subscriptions. Ensure you use the correct one for your subscription type.

Integration setup request parameters

When setting up your integration and executing the API calls, select the appropriate API parameters below according to your subscription type (TMY Basic or TMY Pro) to prevent errors. 

To test the request for TMY Basic and TMY Pro in the API console to the right, enter the generated API token in the console and amend the request parameters according to the following table:

Important: Do not modify any of the request body parameters. The endpoint will only accept the parameters exactly as listed in the table; any changes will cause the call to fail.