Skip to main content

Authorization

Follow this guide to create a new Breezometer credential that will allow Nexla to authenticate to and exchange data with your Breezometer account.
breezometer_api_auth.png

Breezometer

Prerequisites​

The Breezometer API authenticates requests using an API key issued from the BreezoMeter developer dashboard. The key is included as a key query parameter on every request and identifies the account associated with the call for quota management, billing, and feature entitlements. Review the steps below to generate or retrieve the API key required to create a Breezometer credential in Nexla.

BreezoMeter and Google Maps Platform

BreezoMeter was acquired by Google in 2022, and several of its environmental data products have been folded into the Google Maps Platform (Air Quality API, Pollen API, Solar API). The legacy api.breezometer.com endpoints — which this connector targets — continue to be available to existing BreezoMeter customers under their existing keys. New customers building environmental data integrations should also evaluate the Google Maps Platform Air Quality API and Pollen API.

Generate a BreezoMeter API Key​

  1. Sign in to the BreezoMeter Developer Dashboard at developers.breezometer.com/dashboard using the email associated with your BreezoMeter account.

  2. From the dashboard, click the API Keys link in the side navigation to open the API key management page.

  3. Click Create API Key (or Generate New Key), enter a descriptive name for the key (for example, nexla-integration), and confirm. The dashboard displays the newly generated key value immediately after creation.

  4. Copy the API key value and store it in a secure secret manager. The key grants access to the products your BreezoMeter plan enables (Air Quality, Pollen, Weather, Wildfire Tracker+, Tiles, Insights), so it should be treated like a password.

    Each Breezometer endpoint is gated by the products enabled on your plan. If a request returns a permissions error, confirm in the developer dashboard that the relevant product (for example, Wildfire Tracker+ for the area-monitoring endpoints, or Tiles for the heatmap endpoints) is enabled for the API key being used.

For complete information about generating and managing API keys, see the BreezoMeter API Introduction.

Important

The API key grants access to BreezoMeter API quota and data tied to your account. Store it in a secure secret manager, never commit it to source control, and rotate the key immediately if you suspect it has been exposed.

Create a Breezometer Credential​

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

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 to 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​

  1. Enter the API key generated from the BreezoMeter Developer Dashboard in the API Key Value field. Nexla stores this value as an encrypted secret and automatically appends it as the key URL parameter on every Breezometer API request.

    The Breezometer connector includes a built-in connection test that calls GET https://api.breezometer.com/air-quality/v2/current-conditions?lat=48.857456&lon=2.354611 with the supplied key to verify the credential is valid. If the test fails, confirm that the key has not been revoked and that the Air Quality product is enabled for the key in the BreezoMeter dashboard.

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.