EXT: Openweather API¶

What does it do?¶

This extension displays weather forecasts in a frontend plugin. The forecast information is based on the openweather API provided by wetter.com.

More information about openweather API and related terms & conditions can be found at http://www.wetter.com/apps_und_mehr/website/api/ .

Screenshots¶

The extension displays weather forecast for three days (current + 2 days):

Users manual ------------

Registration at wetter.com¶

In order to use the extension you need to create an user account and project subscription at wetter.com. First go to http://www.wetter.com/mein_wetter/register/ and create an user account:

Then log in and create a new subscription for your project at http://www.wetter.com/apps_und_mehr/website/api/projekte/ :

Please read the terms & conditions (AGB) of www.wetter.com carefully. The free API interface is currently limited to 10,000 requests per month.

After submitting the registration form you find your project name(s) and related API key(s) in the list. You will need these properties later for the configuration of the extension.

Click on the project name to configure your subscription. In section “Vorhersageeinstellungen” you can configure the amount of forecasts (“Anzahl der Vorhersagetage”, from 1 to 3 days) and the forecast attributes (“Felder der Vorhersageantwort”). Please include at least the following attributes in your forecast settings. Otherwise some fields will remain empty in frontend. Please do not forget to hit the save button at the bottom (“Vorhersageeinstellungen speichern”) to save your settings.

Installation of the extension¶

Installation of the Typo3 extension is very simple. Just download the extension from TER and install it. Then add the static TypoScript template of the openweatherapi extension to your site template:

Plugin content element ^^^^^^^^^^^^^^^^^^^^^^

Insert a content element of type “plugin” on your website and select the openweatherapi extension (Weather forecast).

Insert the corresponding values for the properties “Project name” and “API Key” from your wetter.com subscription (see section “Registration at wetter.com” above).

In the field “City Code” enter the code of the location for which you want to display the weather forecast. To find the right city code just open the URL http://www.wetter.com and perform a search for your preferred location. The city code is displayed in the result URL, e.g. for Berlin it is DE0001020:

Save your plugin and open the corresponding page in frontend. Now you should see the weather forecast for your preferred location:

Configuration -------------

FAQ¶

Reference¶

Reference of TypoScript options.

Limitations of openweather API¶

The XML data fetched from openweather API contains several attributes. The wetter.com frontend allows individual selection and deselection of attributes for each project. Please make sure that all necessary attributes are included in your subscription (see section “Registration at wetter.com”).

The amount of forecasts can also be changed for each wetter.com subscription. This setting also affects the number of forecast days displayed on your web site (see section “Registration at wetter.com”).

The XML data includes some text attributes in German language only. Wetter.com does not provide a translation for that, e.g. text of weather conditions (“leicht bewölkt”, “wolkig”, etc.).

Limitations of this extension¶

Openweather API provides all-day forecast data and individual forecast data for certain time frames per day in the XML file. The extension does not support the individual forecasts per day, e.g. 6:00 am, 11:00 am, 5:00 pm and 11:00 pm. Currently it supports only the all-day values.

The extension uses normal Typo3 caching to limit requests to openweather API service and speedup frontend rendering. If you want to update weather forecasts more often you have to either disable caching or set the cache lifetime to a shorter interval for the page that includes the plugin.

1.2.1¶

1.2.0¶

1.1.0¶

1.0.0¶