TikTok v2 Provider for OAuth 2.0 Client

This package provides TikTok OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Requirements

The following versions of PHP are supported.

• PHP 7.4
• PHP 8.0
• PHP 8.1

Installation

$ composer require bastiaandewaele/oauth2-tiktok

Scopes

Ensure that your app has the following scopes enabled when creating an app.

• user.info.basic
• video.list
• video.upload
• video.publish

With the scopes above, the resource owner will fetch the fields avatar_url, avatar_url_100, avatar_url_200 , avatar_large_url , display_name.

More fields

If you need fields for metrics or profile link you need to add more scopes.

$authorizationUrl = $this->provider->getAuthorizationUrl(
    [
        'scope' => [
            'user.info.basic',
            'video.list',
            'video.upload',
            'video.publish',
            // These scopes only work if TikTok approved them
            'user.info.profile', // <-- bio_description, is_verified, ...
            'user.info.stats', // <-- follower_count, following_count, ...
        ]
    ]
);

Flow authorization

<?php 

use TikTok\OAuth2\Client\Providers\TikTokAuthProvider;

$provider = new TikTokAuthProvider([
    'clientId' => 'xyz',
    'clientSecret' => 'xyz',
    'redirectUri' => 'https://example.com/callback-url'
]);

if (!isset($_GET['code'])) {
    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;
  
// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
 
    unset($_SESSION['oauth2state']);
    exit('Invalid state');
 
} else {
    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);
 
    // Optional: Now you have a token you can look up a users profile data
    try {
 
        // We got an access token, let's now get the user's details
        $team = $provider->getResourceOwner($token);
 
        // Use these details to create a new profile
        printf('Hello %s!', $team->getName());
 
    } catch (Exception $e) {
 
        // Failed to get user details
        exit('Oh dear...');
    }
 
    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Refreshing a Token

<?php
 
use TikTok\OAuth2\Client\Providers\TikTokAuthProvider;

$provider = new TikTokAuthProvider([
    'clientId' => 'xyz',
    'clientSecret' => 'xyz',
    'redirectUri' => null
]);

$token = $provider->getAccessToken('refresh_token', [
    'refresh_token' => 'xyz'
]);

Running tests

$ ./vendor/bin/phpunit

License

The MIT License (MIT). Please see License File for more information.