Skip to content

API keys

SEPIA Open Assistant edited this page Jun 14, 2020 · 10 revisions

API keys for third-party SEPIA services

Some services integrated in SEPIA require an API key to run properly (e.g. Weather via forecast.io). Here you will find info about these services, how to get the API keys (usually for free with a generous daily limit) and use them.

How to add an API-key to SEPIA

Look for the config file "assist.*.properties" (usually "custom" when you are using the SEPIA custom-bundle with it's start scripts) in the "[SEPIA]/sepia-assist-server/Xtensions/" folder. Open it with a text-editor and scroll down to the bottom. There you will find the entries for each supported third-party service. Add your keys and save the changes then restart the SEPIA assist-server.

Weather - Common

The new weather service in SEPIA v2.5.0 does not require an API key (at the moment) thanks to the great work of the Norwegian Meteorological Institute BUT some parts of the service require geo-search, e.g. when you say "New York" the geo-coder has to find the corresponding GPS location. This currently still requires a "Google Maps" API key (working on alternatives).

Forecast.io/DarkSky

Info: The pre v2.5.0 weather service in SEPIA. It has been bought by Apple will be unavailable for developers soon :-(
Get key: https://darksky.net/dev/register - 1000 calls per day free
Value in config file:
forecast_io_key=...

Google Maps

Info: Currently the default GEO-coder service in SEPIA. Required to get names for places and GPS coordinates.
Get key: https://cloud.google.com/maps-platform - ~10000 calls per month free
Value in config file:
google_maps_key=...

Spotify API

Info: Required if you want to search the Spotify database and generate URIs for songs etc. that can be used to start the app.
Get key: Register here: https://www.spotify.com/de/signup/ then log-in here: https://developer.spotify.com/dashboard/ and go to: CREATE CLIENT ID, choose and app name (anything) and choose non-commercial. Finally click show client secret and copy the key.
Values in config file:
spotify_client_id=...
spotify_client_secret=...

Clone this wiki locally