jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-21 02:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/spotify.markdown
Jean-Paul van Ravensberg 991e35f37f
Added troubleshooting info (#12008) 
* Added troubleshooting info

The `INVALID_CLIENT: Invalid redirect URI` error can occur when the URL, for example, contains a port number. This can happen if the port number is set in the Base_URL attribute of the HTTP integration.

* Convert text to note box

* ✏️ Tweak

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2020-02-10 13:46:21 +01:00

3.1 KiB
Raw Blame History

title, description, logo, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_quality_scale, ha_codeowners
title description logo ha_category ha_release ha_iot_class ha_config_flow ha_quality_scale ha_codeowners
Spotify Instructions on how to integrate Spotify into Home Assistant. spotify.png
Media Player
0.43 Cloud Polling true silver
@frenck

The spotify media player integration allows you to control Spotify playback from Home Assistant.

Prerequisites

  • Spotify account
  • Spotify application, properly configured (see below).
Controlling the Spotify integration (pause, play, next, etc.) requires a Premium account. If you do not have a Premium account, the integration in the frontend will not show the controls.

To create the required Spotify application:

  • Login to Spotify Developer.
  • Visit the My Applications page.
  • Select Create An App. Enter any name and description.
  • Once your application is created, view it and copy your Client ID and Client Secret, which are used in the Home Assistant configuration file.
  • Add a Redirect URI in one of the following forms:
    • If you are not using SSL: http://<your_home_assistant_url_or_local_ip>/auth/external/callback
    • If you are using SSL: https://<your_home_assistant_url_or_local_ip>/auth/external/callback
  • Click Save after adding the URI.

If you are using an externally accessible address, you will likely also need to set the base_url attribute of the HTTP Integration. This should be set using the same base URL as the redirect URI, e.g., if you used a domain name (not local IP) in the redirect, then use the same domain name in your base_url.

Configuration

To add Spotify to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
spotify:
  client_id: YOUR_CLIENT_ID
  client_secret: YOUR_CLIENT_SECRET

{% configuration %} client_id: description: Client ID from your Spotify application. required: true type: string client_secret: description: Client Secret from your Spotify application. required: true type: string {% endconfiguration %}

Activating the Spotify integration

After you have set up the above:

  • Go to the integrations page in the Home Assistant frontend
  • Go to Integrations
  • Add a new Spotify integration.
  • Follow the steps shown to authenticate Home Assistant with your Spotify account.

If you receive an INVALID_CLIENT: Invalid redirect URI error while trying to authenticate with your Spotify account, make sure to check the Redirect URI in the address bar after adding the new integration. Compare this value with the Redirect URL defined in the Spotify Developer Portal.

URI Links For Playlists

You can send playlists to Spotify using the "media_content_type": "playlist", which are part of the media_player.play_media service.

Unsupported Devices

  • Sonos: Although Sonos is a Spotify Connect device, it is not supported by the official Spotify API.