Module: Tiktok::Open::Sdk

Defined in:
lib/tiktok/open/sdk.rb,
lib/tiktok/open/sdk/config.rb,
lib/tiktok/open/sdk/version.rb,
lib/tiktok/open/sdk/http_client.rb,
lib/tiktok/open/sdk/open_api/user.rb,
lib/tiktok/open/sdk/open_api/auth/user.rb,
lib/tiktok/open/sdk/helpers/auth_helper.rb,
lib/tiktok/open/sdk/open_api/auth/client.rb,
lib/tiktok/open/sdk/open_api/post/publish.rb,
lib/tiktok/open/sdk/helpers/response_helper.rb,
lib/tiktok/open/sdk/helpers/string_utils_helper.rb,
lib/tiktok/open/sdk/helpers/validators/token_validator.rb,
lib/tiktok/open/sdk/helpers/validators/post_info_validator.rb,
lib/tiktok/open/sdk/helpers/validators/source_info_validator.rb,
lib/tiktok/open/sdk/helpers/validators/post_publish_validator.rb

Overview

Main SDK module providing configuration and error handling

Defined Under Namespace

Modules: Helpers, HttpClient, OpenApi Classes: Config, Error, RequestValidationError

Constant Summary collapse

VERSION = 
'0.5.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Config?

SDK configuration object

Returns:



56
57
58
 
# File 'lib/tiktok/open/sdk.rb', line 56

def config
  @config
end

Class Method Details

.client_auth ⇒ OpenApi::Auth::Client

Convenience accessor for client authentication functionality

Examples:

Tiktok::Open::Sdk.client_auth.fetch_client_token

Returns:



102
103
104
 
# File 'lib/tiktok/open/sdk.rb', line 102

def client_auth
  OpenApi::Auth::Client
end

.configure {|config| ... } ⇒ Config

Configures the TikTok Open SDK.

This method yields the configuration object, allowing you to set client credentials and other options.

Examples:

Tiktok::Open::Sdk.configure do |config|
  config.client_key = 'your_key'
  config.client_secret = 'your_secret'
  config.user_auth.auth_url = 'https://www.tiktok.com/v2/auth/authorize/'
  config.user_auth.token_url = 'https://open.tiktokapis.com/v2/oauth/token/'
  config.user_auth.scopes = %w[user.info.basic video.list]
  config.user_auth.redirect_uri = 'https://your-redirect-uri.example.com'
  config.load_omniauth = true
end

Yield Parameters:

  • config (Config) —

    the configuration object

Returns:

  • (Config) —

    the configured object



76
77
78
79
80
81
82
83
84
 
# File 'lib/tiktok/open/sdk.rb', line 76

def configure
  self.config ||= Config.new

  yield(config)

  load_omniauth! if config.load_omniauth

  config
end

.post ⇒ OpenApi::Post::Publish

Convenience accessor for post publish functionality

Examples:

Tiktok::Open::Sdk.post.video_init(access_token: 'token', post_info: post_info, source_info: source_info)

Returns:



112
113
114
 
# File 'lib/tiktok/open/sdk.rb', line 112

def post
  OpenApi::Post::Publish
end

.user ⇒ OpenApi::User

Convenience accessor for user functionality

Examples:

Tiktok::Open::Sdk.user.info(access_token: 'token')

Returns:



122
123
124
 
# File 'lib/tiktok/open/sdk.rb', line 122

def user
  OpenApi::User
end

.user_auth ⇒ OpenApi::Auth::User

Convenience accessor for user authentication functionality

Examples:

Tiktok::Open::Sdk.user_auth.authorization_uri

Returns:



92
93
94
 
# File 'lib/tiktok/open/sdk.rb', line 92

def user_auth
  OpenApi::Auth::User
end