Spotify iOS SDK Documentation

Use SPTSessionManager to authenticate users and obtain access tokens. The SDK automatically handles the flow by attempting to open the Spotify app via a custom URL scheme, falling back to ASWebAuthentication if the app is not installed.

Setup Steps

1. Configure Info.plist: Add the spotify scheme to LSApplicationQueriesSchemes to allow the SDK to detect the Spotify app.

2. Initialize Configuration: Create an SPTConfiguration with your clientID and redirectURL. You can optionally set playURI to start playback during authorization.

3. Set Token Swap URLs (Optional): If using the Token Swap method (see PKCE vs Token Swap), provide your backend's tokenSwapURL and tokenRefreshURL in the configuration.

4. Initialize Session Manager: Create the SPTSessionManager using your configuration and a delegate conforming to SPTSessionManagerDelegate.

5. Handle Redirects: Implement the appropriate URL handling in your SceneDelegate or AppDelegate to pass the returned token back to the sessionManager.

6. Implement Delegate: Handle success (didInitiate), renewal (didRenew), or failure (didFailWith) in your SPTSessionManagerDelegate implementation.

7. Start Authorization: Call initiateSession(with:options:campaign:) with the required SPTScope.

// 1. Info.plist
// <key>LSApplicationQueriesSchemes</key>
// <array><string>spotify</string></array>

// 2. Configuration
let configuration = SPTConfiguration(
    clientID: "your_client_id",
    redirectURL: URL(string: "your_redirect_uri")!
)

// 3. (Optional) Token Swap
configuration.tokenSwapURL = URL(string: "http://[your_server]/swap")
configuration.tokenRefreshURL = URL(string: "http://[your_server]/refresh")

// 4. Session Manager
self.sessionManager = SPTSessionManager(configuration: configuration, delegate: self)

// 5. Handle Redirects (SceneDelegate example)
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else { return }
    sessionManager.application(UIApplication.shared, open: url, options: [:])
}

// 6. Delegate
func sessionManager(manager: SPTSessionManager, didInitiate session: SPTSession) {
    // Success
    print("Access Token: \(session.accessToken)")
}

// 7. Initiate
let scope: SPTScope = [.userFollowRead, .appRemoteControl]
sessionManager.initiateSession(with: scope, options: .default, campaign: nil)

To run the SPTLoginSampleAppObjc demo project, which demonstrates the authentication capabilities of the Spotify iOS SDK, follow these steps:

1. Install XcodeGen: Use Homebrew to install the project generator.
2. Generate Project: Run xcodegen within the demo project directory to create the .xcodeproj file.
3. Open Project: Open SPTLoginSampleAppObjc.xcodeproj in Xcode.
4. Configure Spotify Dashboard:
   • Create a new app at https://developer.spotify.com/dashboard.
   • Set a name and description.
   • Crucial: Add the redirect URI: spotify-login-sdk-test-app-objc://spotify-login-callback.
   • Ensure the iOS SDK checkbox is selected.
5. Configure Xcode Settings: Edit your project settings to use the bundle identifier com.spotify.SPTLoginSampleAppObjc.
6. Link Client ID: Copy your clientID from the Spotify Dashboard and paste it into ViewController.m.

# Install XcodeGen
brew install xcodegen

# Generate the Xcode project
xcodegen

To run the NowPlayingView demo project, you must generate the Xcode project using XcodeGen and configure your Spotify Developer credentials.

1. Install XcodeGen using Homebrew: brew install xcodegen.
2. Run xcodegen from within the demo project directory to generate the .xcodeproj file.
3. Open NowPlayingView.xcodeproj in Xcode.
4. Configure your Spotify App in the Spotify Developer Dashboard:
   • Create a new app with a name and description.
   • Add the redirect URI: spotify-ios-test-app://spotify-login-callback.
   • Enable the iOS SDK checkbox.
5. In the demo project, edit the Settings to include the bundle identifier com.spotify.SpotifyAppRemoteDemo.
6. Copy your clientID from the Spotify Dashboard and paste it into SceneDelegate.swift.

# Install XcodeGen
brew install xcodegen

# Generate the Xcode project
xcodegen

Depending on whether you use a Custom URL Scheme or Universal Links, and whether you use the modern SceneDelegate or legacy AppDelegate pattern, you must implement the following methods to pass the authorization response to SPTSessionManager.

SceneDelegate (iOS 13+)

Custom URL Schemes (myapp://callback):

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else { return }
    sessionManager.application(UIApplication.shared, open: url, options: [:])
}

Universal Links (https://myapp.com/callback):

func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
        sessionManager.application(UIApplication.shared, continue: userActivity, restorationHandler: nil)
    }
}

AppDelegate (Legacy/iOS 12 and below)

Custom URL Schemes:

func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    return sessionManager.application(application, open: url, options: options)
}

Universal Links:

func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    return sessionManager.application(application, continue: userActivity, restorationHandler: restorationHandler)
}

To run the SPTLoginSampleAppSwift demo project, which demonstrates the integration of authentication and remote control, follow these steps:

1. Install XcodeGen: Use Homebrew to install the project generator: brew install xcodegen.
2. Generate Project: Run xcodegen within the demo project directory.
3. Open Project: Open the generated SPTLoginSampleAppSwift.xcodeproj in Xcode.
4. Configure Spotify Dashboard:
   • Create a new app at https://developer.spotify.com/dashboard.
   • Set the Redirect URI to: spotify-login-sdk-test-app-swift://spotify-login-callback.
   • Ensure the iOS SDK checkbox is selected.
5. Configure App Settings: Edit the project settings to add the bundle ID com.spotify.SPTLoginSampleAppSwift.
6. Add Client ID: Copy your clientID from the Spotify Dashboard into ViewController.swift.

After authorization, you must connect to the App Remote and set a delegate to listen for connection events. To react to music changes, use the playerAPI to subscribe to player state changes.

// 1. Connect
self.appRemote.delegate = self
self.appRemote.connect()

// MARK: AppRemoteDelegate
func appRemoteDidEstablishConnection(_ appRemote: SPTAppRemote) {
    // Connection successful
}
func appRemote(_ appRemote: SPTAppRemote, didFailConnectionAttemptWithError error: Error?) {}
func appRemote(_ appRemote: SPTAppRemote, didDisconnectWithError error: Error?) {}

// 2. Subscribe to Player State
self.appRemote.playerAPI?.delegate = self
self.appRemote.playerAPI?.subscribe(toPlayerState: { result, error in
    // Handle Errors
})

// MARK: SPTAppRemotePlayerStateDelegate
func playerStateDidChange(_ playerState: SPTAppRemotePlayerState) {
    print("track name \(playerState.track.name)")
}