Skip to main content

Authorization

Follow this guide to create a new OpenWeather API credential that will allow Nexla to authenticate to and exchange data with the OpenWeather API service.
openweathermap_api_auth.png

OpenWeather

Prerequisites​

Before creating an OpenWeather API credential, you need to obtain your API key from your OpenWeather account. OpenWeather uses API key authentication for all API requests, with the API key sent as a query parameter (appid) in the API request URL.

To obtain your OpenWeather API key, follow these steps:

  1. Sign in to your OpenWeather account, or create a new account at OpenWeather.

  2. Navigate to your account dashboard or profile settings in the OpenWeather interface.

  3. Look for the API keys or API section in your account settings or dashboard.

  4. If you don't have an API key yet, click Generate API Key or Create API Key to create a new API key.

  5. Configure your API key settings:

    • Enter a name or description for the API key (e.g., "Nexla Integration")
    • Review and select the API subscription plan or usage limits for the key

  6. Click Generate or Create to create the API key.

  7. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  8. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent as a query parameter (appid) in the API request URL for all API requests to the OpenWeather API (e.g., https://api.openweathermap.org/data/2.5/weather?appid={api_key}&q=San+Francisco). The API key authenticates your requests and grants access to OpenWeather resources based on your account plan and usage limits. If your API key is compromised, you should immediately regenerate it in your OpenWeather account settings and update your credential. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the OpenWeather API documentation.

Create an OpenWeather API Credential​

  • To create a new OpenWeather API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – OpenWeather

OpenWeatherCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

OpenWeather uses API key authentication for all API requests. The API key is sent as a query parameter (appid) in the API request URL to authenticate API requests to the OpenWeather API.

  1. Enter your OpenWeather API key in the API Key field. This is the API key you obtained from your OpenWeather account settings (API keys section). The API key is sent as a query parameter (appid) in the API request URL for all API requests to the OpenWeather API. The API key is sensitive information and must be kept confidential.

    Your OpenWeather API key can be found in your OpenWeather account settings under the API keys section. The API key is sent as a query parameter (appid) in the API request URL for all API requests to the OpenWeather API (e.g., https://api.openweathermap.org/data/2.5/weather?appid={api_key}&q=San+Francisco).

    If your API key is compromised, you should immediately regenerate it in your OpenWeather account settings and update your credential. The API key provides access to your OpenWeather account and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the OpenWeather API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.