-
-
Notifications
You must be signed in to change notification settings - Fork 16
API keys
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.
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.
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).
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=...
Info: One of the available GEO-coder services in SEPIA. Used to get names for places, GPS coordinates or directions.
Get key: https://console.cloud.google.com/apis/dashboard - Check the current quota for free API calls
Values in config file:
default_geo_api=google
default_poi_api=google
default_directions_api=google
google_maps_key=...
Info: One of the available GEO-coder services in SEPIA. Used to get names for places, GPS coordinates or directions.
Get key: https://www.graphhopper.com/developers/ - Create an account and check the quota for free API calls
Values in config file:
default_geo_api=graphhopper
default_poi_api=graphhopper
default_directions_api=graphhopper
graphhopper_key=...
Info: Used to search videos on YouTube. You can define a different API URL if required.
Get key: https://console.cloud.google.com/apis/dashboard - Check the current quota for free API calls
Value in config file:
youtube_api_key=...
youtube_api_url=https://youtube.googleapis.com/youtube/v3/search
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=...
Info: Used to generate direct answers for the current German 1. Bundesliga season.
Get key: OpenLigaDB is completely free, so use reasonable and consider supporting them: https://www.openligadb.de
Values in config file:
Look for the entry background_workers and add the string OpenLigaDB-worker to the existing entry, e.g.:
background_workers=JSON-Backup-worker,RSS-feed-worker,OpenLigaDB-worker