Generating API tokens

  • Updated on Jan 30, 2025
  • Published on Jan 29, 2025
  • 3 minute(s) read
  • MK

In this document

You will learn how to generate API tokens to connect to data delivery services such as TMY or Time Series data downloads.

API tokens

This section is available to admin users only.

An API token is a secure string used to authenticate and authorize your access to our Solargis data services. You will need it to gain access to Solargis TMY or Time Series data. The tokens are generated and managed in the account administration section.

Generating your API tokens

API tokens are generated per service. For example, you will need one token for TMY data and another for Time Series downloads. Available data services depend on your account subscription or purchased add-ons. We offer two token types - user tokens and useless tokens.

The token is directly linked to a user for whom it has been generated. Only this user can use it to make calls to the Solargis API with this token.

Userless tokens are anonymous tokens. They have the same functionality as user tokens, but they are not tied to a user, and anyone can use them.

To generate a token:

  1. In your account administration, navigate to the API section. Available data services will be listed.

  2. Click the “Manage” link of the service you want to create a token.

You will be redirected to the API subscription page. The basic information about the API subscription is provided in the General tab.

Generating user tokens

  1. Navigate to the "Users and user tokens tab. A list of users and their API subscriptions will be listed.

  2. Use the toggle to activate/deactivate the API subscription for the required user.

  3. Generate a new token by clicking the “Generate token” link. If you have activated access for a new user, you must save the changes using the “Save” button first to activate the link.

  4. Copy or download the token. The system will also create and attach an ID to it for easier tracking. A user can have more than one token under his name.

The token will be shown only once - make sure you save it. If you lose it, you will have to generate a new one

Generating userless tokens

  1. Navigate to the "Userless tokens tab. A list of existing API tokens will be listed.

  2. Generate the token using the “Generate token” link.

  3. Copy or download the token. The system will also create and attach an ID to it for easier tracking.

The token will be shown only once - make sure you save it. If you lose it, you will have to generate a new one

Regenerating API tokens

Tokens are displayed only once upon their generation. If you lose it, you must generate a new one. Older tokens remain working until manually deleted to ensure the existing connections keep working without disruptions.

You can generate a new user token using the “Generate token” link next to the user while on the API subscription management page. A new token will be added to the user’s tokens.

You can generate new userless tokens using the “Generate token” directly on the Userless tokens page.  

Managing API tokens

As an admin, you can activate/deactivate user access to API subscriptions and rename or delete tokens. All is done on the respective User or Userless tokens pages. The process is identical for both token types. User token management is available using the “Manage” link next to the user and userless tokens are managed directly on the Userless tokens page.

To rename/delete tokens, use the respective links to rename or delete it.

When deleting a token, ensure there are no services connected through it. Connections using this token will cease to operate once it is deleted.

API usage history

You can check your usage history on the Usage history page. The calls are stored here for 7 days.