Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an OpenWeather API source in Nexla.
openweathermap_api.png

OpenWeather

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the OpenWeather connector tile from the list of available connectors. Then, select the credential that will be used to connect to your OpenWeather account, and click Next; or, create a new OpenWeather API credential for use in this flow.

  3. In Nexla, OpenWeather API data sources can be created using pre-built endpoint templates, which expedite source setup for common OpenWeather API endpoints. Each template is designed specifically for the corresponding OpenWeather API endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    OpenWeather API sources can also be configured manually, allowing you to ingest data from OpenWeather API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common OpenWeather API endpoints. Each template is designed specifically for the corresponding OpenWeather API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Current Weather for City Name

    This endpoint template fetches current weather data for one location by city name from the OpenWeather API. Use this template when you need to retrieve current weather conditions, temperature, humidity, wind speed, and other weather metrics for a specific city. You can call by city name or city name, state and country code. API responds with a list of results that match a searching word.

    • Enter the city name in the City Name field. This should be the name of the city for which you want to fetch current weather data (e.g., London, New York, San Francisco). You can also include state and country code for more specific results (e.g., London, GB, New York, NY, US). The city name is used as a query parameter in the API request.

    This endpoint fetches current weather data for a specific location by city name. The API responds with a list of results that match the searching word, so you may receive multiple results if the city name matches multiple locations. The endpoint returns current weather conditions including temperature, humidity, wind speed, pressure, visibility, and weather descriptions.

    For detailed information about current weather data, API response structures, available weather metrics, and location search options, see the OpenWeather API documentation.

    Current Weather for City Id

    This endpoint template fetches current weather data for one location by City ID from the OpenWeather API. Use this template when you need to retrieve current weather conditions for a specific city using its unique City ID, which provides exact results without ambiguity.

    • Enter the city ID in the City Id field. This should be the unique identifier of the city for which you want to fetch current weather data. The City ID is a numeric identifier assigned by OpenWeather to each city, providing exact location matching. Refer to the OpenWeather API documentation for City ID lists.

    This endpoint fetches current weather data for a specific location by City ID. The API responds with exact results for the specified City ID, eliminating ambiguity that may occur with city name searches. The endpoint returns current weather conditions including temperature, humidity, wind speed, pressure, visibility, and weather descriptions.

    For detailed information about current weather data, City ID lists, API response structures, and available weather metrics, see the OpenWeather API documentation.

    Current Weather for Geographic Coordinates

    This endpoint template fetches current weather data for one location by geographic coordinates (latitude and longitude) from the OpenWeather API. Use this template when you need to retrieve current weather conditions for a specific location using its precise geographic coordinates.

    • Enter the latitude in the Latitude field. This should be the latitude coordinate of the location for which you want to fetch current weather data (e.g., 37.7749 for San Francisco). The latitude must be a valid decimal number between -90 and 90.
    • Enter the longitude in the Longitude field. This should be the longitude coordinate of the location for which you want to fetch current weather data (e.g., -122.4194 for San Francisco). The longitude must be a valid decimal number between -180 and 180.

    This endpoint fetches current weather data for a specific location by geographic coordinates. The API responds with exact results for the specified latitude and longitude coordinates, providing precise location matching. The endpoint returns current weather conditions including temperature, humidity, wind speed, pressure, visibility, and weather descriptions.

    For detailed information about current weather data, geographic coordinates, API response structures, and available weather metrics, see the OpenWeather API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

OpenWeather API data sources can be manually configured to ingest data from any valid OpenWeather API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex OpenWeather API sources, such as sources that use multiple API calls or sources that require custom query parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the OpenWeather API from the Method pulldown menu. OpenWeather API typically uses GET method for retrieving weather data.

API Endpoint URL​

  1. Enter the URL of the OpenWeather API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your OpenWeather endpoint (e.g., https://api.openweathermap.org/data/2.5/weather?appid={api_key}&q=London). Include your API key as the appid query parameter and any other required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The OpenWeather API requires your API key to be included as the appid query parameter in all requests. The endpoint URL should include your API key and any location parameters (city name, city ID, or coordinates). You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For OpenWeather API responses, use $ to extract the entire response object, as OpenWeather API typically returns a single weather data object per request.

The JSONPath expression must correctly reference the structure of your OpenWeather API response. OpenWeather API responses typically return a single weather data object with nested structures for current conditions, weather descriptions, and location information. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.