用 Spotify 登录

要为你的项目启用 Spotify 认证，你需要设置一个 Spotify OAuth 应用，并把应用的凭证添加到你的 Supabase 控制面板。

🌐 To enable Spotify Auth for your project, you need to set up a Spotify OAuth application and add the application credentials to your Supabase Dashboard.

概览 #

🌐 Overview

为你的应用设置 Spotify 登录由三部分组成：

🌐 Setting up Spotify logins for your application consists of 3 parts:

• 在Spotify开发者控制台上创建并配置一个Spotify项目和应用。
• 将你的 Spotify API Key 和 API Secret Key 添加到你的 Supabase 项目。
• 将登录代码添加到你的 Supabase JS 客户端应用 中。

访问你的 Spotify 开发者账号 #

🌐 Access your Spotify Developer account

• 登录 Spotify
• 访问 Spotify 开发者控制面板

找到你的回调网址 #

🌐 Find your callback URL

下一步需要一个回调 URL，看起来像这样：https://<project-ref>.supabase.co/auth/v1/callback

• 前往你的 Supabase 项目仪表板
• 点击左侧边栏的 Authentication 图标
• 在配置部分点击Sign In / Providers
• 点击手风琴列表中的 Spotify 展开，你就会找到你的 回调 URL，你可以点击 Copy 将其复制到剪贴板

本地开发 #

🌐 Local development

在本地使用 Supabase CLI 测试 OAuth 时，确保你的 OAuth 提供商已配置本地 Supabase Auth 回调 URL：

🌐 When testing OAuth locally with the Supabase CLI, ensure your OAuth provider is configured with the local Supabase Auth callback URL:

http://localhost:54321/auth/v1/callback

如果这个回调 URL 缺失或配置错误，OAuth 登录可能会失败，或者在本地开发时无法正确跳转。

🌐 If this callback URL is missing or misconfigured, OAuth sign-in may fail or not redirect correctly during local development.

有关更多详情，请查看本地开发文档。

🌐 See the local development docs for more details.

要在本地使用 Supabase CLI 测试 OAuth，请参阅本地开发文档。

🌐 For testing OAuth locally with the Supabase CLI see the local development docs.

创建一个 Spotify OAuth 应用 #

🌐 Create a Spotify OAuth app

• 登录 Spotify。
• 去 Spotify 开发者控制台
• 点击 Create an App
• 输入你的 App name
• 输入你的 App description
• 勾选框表示同意 Developer TOS and Branding Guidelines
• 点击 Create
• 保存你的 Client ID
• 保存你的 Client Secret
• 点击 Edit Settings

在 Redirect URIs 下：

🌐 Under Redirect URIs:

• 在框中粘贴你的 Supabase 回调 URL
• 点击 Add
• 点击底部的 Save

在你的 Supabase 项目中输入你的 Spotify 凭证 #

🌐 Enter your Spotify credentials into your Supabase project

• 前往你的 Supabase 项目仪表板
• 在左侧边栏，点击Authentication图标（靠近顶部）
• 在配置部分点击Providers
• 从手风琴列表中点击 Spotify 来展开，然后将 Spotify 启用 切换为开启
• 输入你在上一步保存的 Spotify 客户端 ID 和 Spotify 客户端密钥
• 点击 Save

你也可以使用管理 API 配置 Spotify 身份验证提供者：

🌐 You can also configure the Spotify auth provider using the Management API:

1
# Get your access token from https://supabase.com/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
export PROJECT_REF="your-project-ref"
4
5
# Configure Spotify auth provider
6
curl -X PATCH "https://api.supabase.com/v1/projects/$PROJECT_REF/config/auth" \
7
  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
8
  -H "Content-Type: application/json" \
9
  -d '{
10
    "external_spotify_enabled": true,
11
    "external_spotify_client_id": "your-spotify-client-id",
12
    "external_spotify_secret": "your-spotify-client-secret"
13
  }'

在你的客户端应用中添加登录代码 #

🌐 Add login code to your client app

以下是使用 Spotify 登录 Supabase 身份验证的步骤。

🌐 The following outlines the steps to sign in using Spotify with Supabase Auth.

1. 从客户端库调用signin方法。
2. 用户被重定向到 Spotify 登录页面。
3. 完成登录过程后，用户会被重定向回你的应用，并显示一个错误，提示电子邮件地址需要确认。同时，用户会收到来自 Supabase Auth 的确认邮件。
4. 用户点击邮件中的确认链接。
5. 用户被带回到应用中，现在已经登录了。

1
import { createClient } from '@supabase/supabase-js'
2
3
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
4
5
// ---cut---
6
async function signInWithSpotify() {
7
  const { data, error } = await supabase.auth.signInWithOAuth({
8
    provider: 'spotify',
9
  })
10
}

以 PKCE 流程为例，比如在服务端认证中，你需要一个额外的步骤来处理代码交换。在调用 signInWithOAuth 时，提供一个指向回调路由的 redirectTo URL。这个重定向 URL 应该添加到你的 重定向允许列表 中。

🌐 For a PKCE flow, for example in Server-Side Auth, you need an extra step to handle the code exchange. When calling signInWithOAuth, provide a redirectTo URL which points to a callback route. This redirect URL should be added to your redirect allow list.

1
import { createClient, type Provider } from '@supabase/supabase-js';
2
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
3
const provider = 'provider' as Provider
4
5
// ---cut---
6
await supabase.auth.signInWithOAuth({
7
  provider,
8
  options: {
9
    redirectTo: `http://example.com/auth/callback`,
10
  },
11
})

在回调端点，处理代码交换以保存用户会话。

🌐 At the callback endpoint, handle the code exchange to save the user session.

1
import { NextResponse } from 'next/server'
2
3
// The client you created from the Server-Side Auth instructions
4
import { createClient } from '@/utils/supabase/server'
5
6
export async function GET(request: Request) {
7
  const { searchParams, origin } = new URL(request.url)
8
  const code = searchParams.get('code')
9
  // if "next" is in param, use it as the redirect URL
10
  let next = searchParams.get('next') ?? '/'
11
  if (!next.startsWith('/')) {
12
    // if "next" is not a relative URL, use the default
13
    next = '/'
14
  }
15
16
  if (code) {
17
    const supabase = await createClient()
18
    const { error } = await supabase.auth.exchangeCodeForSession(code)
19
    if (!error) {
20
      const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer
21
      const isLocalEnv = process.env.NODE_ENV === 'development'
22
      if (isLocalEnv) {
23
        // we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host
24
        return NextResponse.redirect(`${origin}${next}`)
25
      } else if (forwardedHost) {
26
        return NextResponse.redirect(`https://${forwardedHost}${next}`)
27
      } else {
28
        return NextResponse.redirect(`${origin}${next}`)
29
      }
30
    }
31
  }
32
33
  // return the user to an error page with instructions
34
  return NextResponse.redirect(`${origin}/auth/auth-code-error`)
35
}

1
import { createClient } from '@supabase/supabase-js'
2
3
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
4
5
// ---cut---
6
async function signOut() {
7
  const { error } = await supabase.auth.signOut()
8
}

资源 #

🌐 Resources

• Supabase - 免费开始
• Supabase JS 客户端
• Spotify 开发者控制台