Crate rspotify

Expand description

Rspotify is a wrapper for the Spotify Web API, inspired by spotipy. It includes support for all the authorization flows, and helper methods for all available endpoints.

Configuration

HTTP Client

By default, Rspotify uses the reqwest asynchronous HTTP client with its default TLS, but you can customize both the HTTP client and the TLS with the following features:

reqwest: enabling client-reqwest, TLS available:
- reqwest-default-tls (reqwest’s default)
- reqwest-rustls-tls
- reqwest-native-tls
- reqwest-native-tls-vendored
ureq: enabling client-ureq, TLS available:
- ureq-rustls-tls (ureq’s default)

If you want to use a different client or TLS than the default ones, you’ll have to disable the default features and enable whichever you want. For example, this would compile Rspotify with reqwest and the native TLS:

[dependencies]
rspotify = {
    version = "...",
    default-features = false,
    features = ["client-reqwest", "reqwest-native-tls"]
}

maybe_async internally enables Rspotify to use both synchronous and asynchronous HTTP clients. You can also use ureq, a synchronous client, like so:

[dependencies]
rspotify = {
    version = "...",
    default-features = false,
    features = ["client-ureq", "ureq-rustls-tls"]
}

Proxies

reqwest supports system proxies by default. It reads the environment variables HTTP_PROXY and HTTPS_PROXY environmental variables to set HTTP and HTTPS proxies, respectively.

Environmental variables

Rspotify supports the dotenv crate, which allows you to save credentials in a .env file. These will then be automatically available as environmental values when using methods like Credentials::from_env.

[dependencies]
rspotify = { version = "...", features = ["env-file"] }

CLI utilities

Rspotify includes basic support for Cli apps to obtain access tokens by prompting the user, after enabling the cli feature. See the Authorization section for more information.

Getting Started

Authorization

All endpoints require app authorization; you will need to generate a token that indicates that the client has been granted permission to perform requests. You can start by registering your app to get the necessary client credentials. Read the official guide for a detailed explanation of the different authorization flows available.

Rspotify has a different client for each of the available authentication flows. They may implement the endpoints in BaseClient or OAuthClient according to what kind of flow it is. Please refer to their documentation for more details:

Client Credentials Flow: see ClientCredsSpotify.
Authorization Code Flow: see AuthCodeSpotify.
Authorization Code Flow with Proof Key for Code Exchange (PKCE): see AuthCodePkceSpotify.
Implicit Grant Flow: unimplemented, as Rspotify has not been tested on a browser yet. If you’d like support for it, let us know in an issue!

In order to help other developers to get used to rspotify, there are public credentials available for a dummy account. You can test rspotify with this account’s RSPOTIFY_CLIENT_ID and RSPOTIFY_CLIENT_SECRET inside the .env file for more details.