tiktok opensdk ios

適用於 iOS 的 TikTok OpenSDK

介紹

TikTok OpenSDK 是一個框架，使您的用戶能夠使用其 TikTok 帳戶登入您的應用程式並將圖像和影片分享到 TikTok。該 SDK 可透過 Swift Package Manager 和 Cocoapods 下載。

入門

最低 iOS 版本為 12.0，最低 XCode 版本為 10.0。有關詳細信息，請參閱 iOS 快速入門。

開發者入口網站應用程式

在我們的開發者入口網站中註冊開發者帳戶。申請批准後，開發者入口網站將為您提供Client Key和Client Secret 。請在此處查看如何註冊您的應用程式。在繼續之前，請確保導航至Manage apps頁面，然後在開發者入口網站帳戶中按一下+ Add products將登入工具包和/或共用工具包新增至您的應用程式。

安裝SDK

斯威夫特套件管理器

將庫作為 Swift 套件添加到您的 XCode 專案中：

1. 點選File -> Add Packages...
2. 貼上儲存庫 URL： https://github.com/tiktok/tiktok-opensdk-ios ://github.com/tiktok/tiktok-opensdk-ios
3. 選擇Dependency Rule -> Up to Next Major Version並輸入您想要的主要版本（即2.3.0 ）
4. 選擇Add to Project -> 您的項目
5. 點擊Copy Dependency並選擇您需要的庫（ TikTokOpenAuthSDK 、 TikTokOpenSDKCore 、 TikTokOpenShareSDK ）

可可足類

1. 將以下內容新增至您的 Podfile 中

 pod 'TikTokOpenSDKCore'
pod 'TikTokOpenAuthSDK'
pod 'TikTokOpenShareSDK'

2. 運行pod install --repo-update

配置您的 XCode 項目

1. 開啟 Info.plist 檔案並新增/更新以下按鍵。
   • 將以下值加入LSApplicationQueriesSchemes ：
     • tiktokopensdk用於登入套件
     • tiktoksharesdk分享套件
     • snssdk1233和snssdk1180檢查您的裝置上是否安裝了 TikTok。
   • 新增密鑰TikTokClientKey並將您的應用程式Client Key作為值。
   • 將您的應用程式Client Key新增至CFBundleURLSchemes 。

< key >LSApplicationQueriesSchemes</ key >
< array >
    < string >tiktokopensdk</ string >
    < string >tiktoksharesdk</ string >
    < string >snssdk1180</ string >
    < string >snssdk1233</ string >
</ array >
< key >TikTokClientKey</ key >
< string >$TikTokClientKey</ string >
< key >CFBundleURLTypes</ key >
< array >
  < dict >
    < key >CFBundleURLSchemes</ key >
    < array >
      < string >$TikTokClientKey</ string >
    </ array >
  </ dict >
</ array >

2. 將以下程式碼新增至應用程式的 AppDelegate：

import TikTokOpenSDKCore

@ main
class AppDelegate : UIResponder , UIApplicationDelegate {

    func application ( _ app : UIApplication , open url : URL , 
                     options : [ UIApplication . OpenURLOptionsKey : Any ] = [ : ] ) -> Bool {
        if TikTokURLHandler . handleOpenURL ( url ) {
            return true
        }
        return false
    }
        
    func application ( _ application : UIApplication , 
                     continue userActivity : NSUserActivity , 
                     restorationHandler : @escaping ( [ UIUserActivityRestoring ] ? ) -> Void ) -> Bool {
        if userActivity . activityType == NSUserActivityTypeBrowsingWeb {
            if TikTokURLHandler . handleOpenURL ( userActivity . webpageURL ) {
                return true
            }
        }
        return false
    }
    
}

3. 將以下程式碼新增至應用程式的 SceneDelegate 檔案（如果有）：

import TikTokOpenSDKCore

class SceneDelegate : UIResponder , UIWindowSceneDelegate {

    func scene ( _ scene : UIScene , 
               openURLContexts URLContexts : Set < UIOpenURLContext > ) {
        if TikTokURLHandler . handleOpenURL ( URLContexts . first ? . url ) {
            return
        }
    }

} 

登入套件使用

Login Kit 功能依賴TikTokOpenSDKCore和TikTokOpenAuthSDK庫，因此在新增套件或 cocoapods 時請務必選擇這些庫。以下程式碼片段顯示如何建立授權請求並處理回應。有關更多詳細信息，請參閱 iOS 登入套件。

import TikTokOpenAuthSDK

let authRequest = TikTokAuthRequest ( scopes : [ " user.info.basic " ] , redirectURI : " https://www.example.com/path " )
authRequest . send { response in
    let authResponse = response as? TikTokAuthResponse else { return }
    if authResponse . errorCode == . noError {
        print ( " Auth code: ( authResponse . code ) " )
    } else {
       print ( " Authorization Failed! 
             Error: ( authResponse . error ?? " " ) 
             Error Description: ( authResponse . errorDescription ?? " " ) )
    }
}

您的應用程式負責維護對請求的強引用，以便接收回應回呼。完成回應後，您可以將其丟棄。

共享套件使用情況

Share Kit 功能依賴TikTokOpenSDKCore和TikTokOpenShareSDK庫，因此在新增套件或 cocoapods 時請務必選擇這些庫。以下程式碼片段展示如何建立共享請求並處理回應。有關更多詳細信息，請參閱 iOS 共享套件。

import TikTokOpenShareSDK

let shareRequest = TikTokShareRequest ( localIdentifiers : [ ... ] , mediaType : . video , redirectURI : " https://www.example.com/path " )
shareRequest . send { response in
    let shareResponse = response as? TikTokShareResponse else { return }
    if shareResponse . errorCode == . noError {
        print ( " Share succeeded! " )
    } else {
        print ( " Share Failed! 
               Error Code: ( shareResponse . errorCode . rawValue ) 
               Error Message: ( shareResponse . errorMessage ?? " " ) 
               Share State: ( shareResponse . shareState ) " )
    }
}

您的應用程式負責維護對請求的強引用，以便接收回應回呼。完成回應後，您可以將其丟棄。

示範

演示應用程式的最低 iOS 版本是 ShareDemo 的 iOS 14.0 和 LoginDemo 的 iOS 12.0。

1. 開啟LoginDemo/TikTokLoginDemo.xcodeproj或ShareDemo/TikTokShareDemo.xcodeproj 。
2. 為了在實體 iOS 裝置上運行演示，您將需要一個有效的通用鏈接，以及一個具有關聯域功能的設定檔。匯入您的設定文件，更新捆綁包 ID，並將您的通用連結網域新增至「關聯網域」部分。如果您正在執行 LoginDemo，請確保您已將通用連結新增至開發人員入口網站中「登入工具包」部分的「重定向 URI」部分。
3. 開啟Info.plist檔案作為原始碼，並將${TikTokClientKey}的使用替換為開發者入口網站中您自己的客戶端金鑰。
4. 運行該項目以查看該套件的運行情況。

執照

此原始程式碼根據此原始碼樹根目錄中的 LICENSE 檔案中的許可證獲得許可。