Module: Tiktok::Open::Sdk::OpenApi::User

Extended by:
User
Includes:
Helpers::ResponseHelper, Helpers::Validators::TokenValidator
Included in:
User
Defined in:
lib/tiktok/open/sdk/open_api/user.rb

Overview

Provides user-related methods for the TikTok Open API.

Constant Summary collapse

FIELDS =

List of valid user info fields that can be requested from the API.

%w[
  open_id
  union_id
  avatar_url
  avatar_url_100
  avatar_large_url
  display_name
  bio_description
  profile_deep_link
  is_verified
  username
  follower_count
  following_count
  likes_count
  video_count
].freeze

Constants included from Helpers::Validators::TokenValidator

Helpers::Validators::TokenValidator::TOKEN_REGEX

Instance Method Summary collapse

Methods included from Helpers::Validators::TokenValidator

#valid_token?, #validate_token!

Methods included from Helpers::ResponseHelper

#render_response

Methods included from Helpers::StringUtilsHelper

#parse_json

Instance Method Details

#get_user_info(access_token:, fields:, validate: true) ⇒ Hash

Retrieves user information from the TikTok Open API.

Parameters:

  • access_token (String) —

    OAuth2 access token for authentication.

  • fields (Array<String>) —

    User fields to retrieve. Must be a subset of FIELDS.

  • validate (Boolean) (defaults to: true) —

    Whether to validate the token and fields. Defaults to true.

Returns:

  • (Hash) —

    Parsed API response containing user information.

Raises:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/tiktok/open/sdk/open_api/user.rb', line 40

def (access_token:, fields:, validate: true)
  if validate
    validate_token!(access_token)
    validate_fields!(fields)
  end

  render_response Tiktok::Open::Sdk::HttpClient.get(
    Tiktok::Open::Sdk.config.,
    params:  {
      fields: fields.join(',')
    },
    headers: {
      Authorization: "Bearer #{access_token}"
    }
  )
end