Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 3.17 KB

README.md

File metadata and controls

53 lines (43 loc) · 3.17 KB
Raw

spotify-web-api-java

Build Maven Central GitHub

A Java wrapper for Spotify's Web API.

Installation

This library is available on Maven Central and requires at least Java 17.

With maven

<dependency>
  <groupId>de.sonallux.spotify</groupId>
  <artifactId>spotify-web-api-java</artifactId>
  <version>4.3.0</version>
</dependency>

With gradle

compile 'de.sonallux.spotify:spotify-web-api-java:4.3.0'

General usage

var authProvider = new SimpleApiAuthorizationProvider("<your access token>");
var spotifyApi = SpotifyWebApi.builder().authorization(authProvider).build();

var artist = spotifyApi.getArtistsApi().getArtist("<artist id>").build().execute();
System.out.println(artist.getName());

Authorization

Spotify's web API supports different authorization flows. All flows require that your application is registered on the Spotify Developer Dashboard. You can find more details on how to register your app here. After successful registration you can use one of the following authorization flows with the spotify-web-api-java:

Authorization code flow

Code example: AuthorizationCodeExample.java

Authorization code flow with proof key for code exchange (PKCE)

Code example: AuthorizationCodePKCEExample.java

Implicit grant

Code example: ImplicitGrantExample.java

Client credentials flow

Code example: ClientCredentialsExample.java

How to release a new version

  1. Update the version number with ./mvnw versions:set -DnewVersion="<version>" -DgenerateBackupPoms=false
  2. Update version in CHANGELOG.md and README.md
  3. Commit and push changes to GitHub
  4. Wait till CI is green
  5. Tag the commit created in step 3 and push it. A GitHub actions workflow will automatically deploy the artifacts to Maven Central.
  6. Create a release on GitHub mentioning the changes from CHANGELOG.md