Class: Tiktok::Open::Sdk::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/tiktok/open/sdk/config.rb

Overview

Configuration class for TikTok Open SDK.

Holds client credentials and user authentication settings.

Examples:

config = Tiktok::Open::Sdk::Config.new
config.client_key = 'your_key'
config.client_secret = 'your_secret'
config.user_auth.scopes = %w[user.info.basic]

Defined Under Namespace

Classes: UserAuth

Constant Summary collapse

AUTH_BASE_URL =

Base domains for constructing TikTok API URLs.

'https://www.tiktok.com'
OPEN_API_BASE_URL = 
'https://open.tiktokapis.com'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Create a new Config with default user authentication settings.



45
46
47
48
49
50
 
# File 'lib/tiktok/open/sdk/config.rb', line 45

def initialize
  @user_info_url          = "#{OPEN_API_BASE_URL}/v2/user/info/"
  @creator_info_query_url = "#{OPEN_API_BASE_URL}/v2/post/publish/creator_info/query/"
  @user_auth              = UserAuth.new
  @load_omniauth          = false
end

Instance Attribute Details

#client_key ⇒ String

Returns TikTok client key.

Returns:

  • (String) —

    TikTok client key.



22
23
24
 
# File 'lib/tiktok/open/sdk/config.rb', line 22

def client_key
  @client_key
end

#client_secret ⇒ String

Returns TikTok client secret.

Returns:

  • (String) —

    TikTok client secret.



26
27
28
 
# File 'lib/tiktok/open/sdk/config.rb', line 26

def client_secret
  @client_secret
end

#creator_info_query_url ⇒ String

Returns TikTok Query Creator Info endpoint URL.

Returns:

  • (String) —

    TikTok Query Creator Info endpoint URL.



34
35
36
 
# File 'lib/tiktok/open/sdk/config.rb', line 34

def creator_info_query_url
  @creator_info_query_url
end

#load_omniauth ⇒ Boolean

Returns Whether to automatically load OmniAuth strategy.

Returns:

  • (Boolean) —

    Whether to automatically load OmniAuth strategy.



42
43
44
 
# File 'lib/tiktok/open/sdk/config.rb', line 42

def load_omniauth
  @load_omniauth
end

#user_auth ⇒ UserAuth

Returns User authentication configuration.

Returns:

  • (UserAuth) —

    User authentication configuration.



38
39
40
 
# File 'lib/tiktok/open/sdk/config.rb', line 38

def user_auth
  @user_auth
end

#user_info_url ⇒ String

Returns TikTok user info endpoint URL.

Returns:

  • (String) —

    TikTok user info endpoint URL.



30
31
32
 
# File 'lib/tiktok/open/sdk/config.rb', line 30

def 
  @user_info_url
end