providers/tiktok
TiktokProfile
繼承
Record
<string
,any
>
屬性
data
data: {
user: {
avatar_large_url: string;
avatar_url: string;
avatar_url_100: string;
bio_description: string;
display_name: string;
email: string;
follower_count: number;
following_count: number;
is_verified: boolean;
likes_count: number;
open_id: string;
profile_deep_link: string;
union_id: string;
username: string;
video_count: number;
};
};
user
user: {
avatar_large_url: string;
avatar_url: string;
avatar_url_100: string;
bio_description: string;
display_name: string;
email: string;
follower_count: number;
following_count: number;
is_verified: boolean;
likes_count: number;
open_id: string;
profile_deep_link: string;
union_id: string;
username: string;
video_count: number;
};
user.avatar_large_url?
optional avatar_large_url: string;
使用者的高解析度個人資料圖片
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=avatar_url_100
。
user.avatar_url
avatar_url: string;
使用者的個人資料圖片。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=avatar_url
。
user.avatar_url_100?
optional avatar_url_100: string;
使用者 100x100 大小的個人資料圖片。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=avatar_url_100
。
user.bio_description?
optional bio_description: string;
使用者有效的個人簡介說明。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=bio_description
。
user.display_name
display_name: string;
使用者的個人資料名稱
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=display_name
。
user.email?
optional email: string;
注意
TikTok 目前不支援電子郵件
user.follower_count?
optional follower_count: number;
使用者的追蹤者人數。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=follower_count
。
user.following_count?
optional following_count: number;
使用者正在追蹤的帳戶數量。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=following_count
。
user.is_verified?
optional is_verified: boolean;
TikTok 是否在確認帳戶屬於其代表的使用者後,向該帳戶提供了已驗證徽章。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=is_verified
。
user.likes_count?
optional likes_count: number;
使用者所有影片收到的讚總數。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=likes_count
。
user.open_id
open_id: string;
使用者在目前應用程式中的唯一識別碼。用戶端的 Open id。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=open_id
。
user.profile_deep_link?
optional profile_deep_link: string;
使用者 TikTok 個人資料頁面的連結。
若要傳回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=profile_deep_link
。
user.union_id?
optional union_id: string;
使用者在同一開發人員的不同應用程式中的唯一識別碼。例如,如果合作夥伴有 X 個用戶端,則同一 TikTok 使用者會獲得 X 個 open_id,但特定使用者會有一個持續的 union_id。
若要返回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=union_id
。
user.username
username: string;
使用者的使用者名稱。
若要返回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=username
。
user.video_count?
optional video_count: number;
使用者公開發布的影片總數。
若要返回此欄位,請在使用者個人資料請求的查詢參數中加入 fields=video_count
。
error
error: {
code: string;
log_id: string;
message: string;
};
code
code: string;
字串格式的錯誤類別。
log_id
log_id: string;
字串格式的錯誤訊息。
message
message: string;
字串格式的錯誤訊息。
default()
default<P>(options): OAuthConfig<P>
將 TikTok 登入新增至您的頁面。
設定
回呼 URL
https://example.com/api/auth/callback/tiktok
組態設定
import { Auth } from "@auth/core"
import TikTok from "@auth/core/providers/tiktok"
const request = new Request(origin)
const response = await Auth(request, {
providers: [
TikTok({ clientId: TIKTOK_CLIENT_KEY, clientSecret: TIKTOK_CLIENT_SECRET }),
],
})
資源
注意事項
生產應用程式不能使用 localhost URL 登入 TikTok。您需要將網域和回呼/重新導向 URL 新增至您的 TikTok 應用程式,並由 TikTok 團隊審查和批准。
TikTok 不支援電子郵件地址。
Client_ID 將會是 TikTok 應用程式中的 Client Key。
預設情況下,Auth.js 假設 TikTok 提供者是基於 OAuth 2 規範。
TikTok 提供者具有預設組態。若要覆寫您的使用案例的預設值,請查看自訂內建的 OAuth 提供者。
類型參數
類型參數 |
---|
P 延伸自 TiktokProfile |
參數
參數 | 類型 |
---|---|
options | OAuthUserConfig <P > |
返回值
OAuthConfig
<P
>