WeatherStack - Ismena website

info@ismena.com

Weatherstack Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Weatherstack Connector facilitates seamless integration with the Weatherstack API, providing access to real-time, historical, and forecast weather data, as well as location autocomplete functionality for various location identifiers. This connector acts as a proxy to streamline data retrieval, supporting actions for current weather, historical weather, weather forecasts, and location autocomplete.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Weatherstack Connector.

Supported Integration Action Points

getCurrentWeather: Retrieves current weather data for one or multiple locations.
getHistoricalWeather: Retrieves historical weather data for specific dates (back to 2008).
getForecastWeather: Retrieves weather forecast data for up to 14 days into the future.
getLocationAutocomplete: Retrieves location data for search queries to pinpoint specific locations.

Detailed Integration Documentation

2.1 Current Weather Retrieval

Action	getCurrentWeather
Purpose	Retrieves current weather data for one or multiple locations specified by various identifiers (e.g., city name, ZIP code, coordinates, IP address). This serves as the primary entry point for accessing real-time weather data.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY). Register at weatherstack.com to obtain. query: Location identifier(s) (string, e.g., "New York", "99501", "40.7831,-73.9712", "fetch:ip", or "London;Singapore;Shanghai" for multiple locations). Optional: None Configuration: Ensure the connector is configured with the base URL via CONNECTOR_ENV_WEATHERSTACK_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: result: Success status (string, e.g., "success"). request: Object containing request details (e.g., type: "City", query: "New Delhi, India", language: "en", unit: "m"). location: Object with location details (e.g., name: "New Delhi", country: "India", lat: "28.600", lon: "77.200"). current: Object with weather data (e.g., temperature: 28, weather_descriptions: ["Haze"], humidity: 25). For multiple locations, returns an array of such objects. Failure: Returns error details (e.g., error-type: "invalid-query").
Workflow Example	Configure the connector with the appropriate base URL. Execute the getCurrentWeather action with apiKey and query=New York. Process the response to display current weather data in an application.

2.2 Historical Weather Retrieval

Action	getHistoricalWeather
Purpose	Retrieves historical weather data for a specific date or date range (back to 2008) for one or multiple locations. This enables historical weather analysis for research or reporting.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY). query: Location identifier(s) (string, e.g., "New York" or "London;Singapore"). Optional: historical_date: One or multiple semicolon-separated dates (string, e.g., "2015-01-21" or "2015-01-21;2015-01-22"). historical_date_start: Start date for time-series data (string, e.g., "2015-01-21"). historical_date_end: End date for time-series data (string, e.g., "2015-01-25"). hourly: Enable hourly data (integer, 0 or 1, e.g., 1). Configuration: Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: result: Success status (string, e.g., "success"). request: Object with request details (e.g., type: "City", query: "New York"). location: Object with location details (e.g., name: "New York", country: "United States of America"). current: Object with current weather data. historical: Object with historical data for specified dates (e.g., date: "2015-01-21", mintemp: -4, maxtemp: 1, hourly: [{time: "0", temperature: -2}]). Failure: Returns error details (e.g., error-type: "invalid-date").
Workflow Example	Execute the getHistoricalWeather action with apiKey, query=New York, historical_date=2015-01-21, and hourly=1. Review the response to obtain historical weather data. Use the data for historical weather analysis or reporting.

2.3 Weather Forecast Retrieval

Action	getForecastWeather
Purpose	Retrieves weather forecast data for up to 14 days into the future for one or multiple locations. This allows users to plan based on future weather conditions.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY). query: Location identifier(s) (string, e.g., "New York" or "London;Singapore"). Optional: forecast_days: Number of forecast days (integer, e.g., 7). Configuration: Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: result: Success status (string, e.g., "success"). request: Object with request details (e.g., type: "City", query: "New York"). location: Object with location details (e.g., name: "New York", country: "United States of America"). current: Object with current weather data. forecast: Object with forecast data for specified days (e.g., date: "2024-03-18", mintemp: 5, maxtemp: 10). Failure: Returns error details (e.g., error-type: "invalid-query").
Workflow Example	Execute the getForecastWeather action with apiKey, query=New York, and forecast_days=7. Review the response to obtain forecast data. Use the data for weather forecasting applications or planning.

2.4 Location Autocomplete Retrieval

Action	getLocationAutocomplete
Purpose	Retrieves location data for search queries to pinpoint specific locations. This helps users validate or select locations for weather data queries.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY). query: Location search query (string, e.g., "London"). Optional: None Configuration: Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: result: Success status (string, e.g., "success"). request: Object with request details (e.g., query: "London", results: 2). results: Array of location objects (e.g., name: "London", country: "United Kingdom", lat: "51.517", lon: "-0.106"). Failure: Returns error details (e.g., error-type: "invalid-query").
Workflow Example	Execute the getLocationAutocomplete action with apiKey and query=London. Review the response to select location identifiers. Use the identifiers to fetch weather data for specific locations.

Workflow Creation with the Connector

Example Workflow: Weather Data Retrieval and Location Selection

Retrieve Location Data	Use the getLocationAutocomplete action with apiKey and query=London to fetch location identifiers. Identify target locations (e.g., "London, United Kingdom").
Query Current Weather	Execute the getCurrentWeather action with apiKey and query=London to fetch current weather data. Process the response to display weather conditions in a dashboard.
Explore Historical Weather	Execute the getHistoricalWeather action with apiKey, query=London, historical_date=2015-01-21, and hourly=1 to fetch historical weather data. Analyze historical data for research or trend analysis.
Fetch Weather Forecast	Execute the getForecastWeather action with apiKey, query=London, and forecast_days=7 to fetch forecast data. Integrate the data into a weather forecasting application for improved user experience.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event