bastiaandewaele/oauth2-tiktok

v2.0.0 2023-07-03 17:59 UTC

This package is auto-updated.

Last update: 2024-09-06 17:18:22 UTC


README

Software License

此包为 PHP League 的 OAuth 2.0 客户端 提供了 TikTok OAuth 2.0 支持。

要求

以下版本的 PHP 受支持。

  • PHP 7.4
  • PHP 8.0
  • PHP 8.1

安装

$ composer require bastiaandewaele/oauth2-tiktok

作用域

在创建 应用 时,请确保您的应用已启用以下作用域。

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

使用上述作用域,资源所有者将获取字段 avatar_urlavatar_url_100avatar_url_200avatar_large_urldisplay_name

更多字段

如果您需要用于指标或个人资料链接的字段,需要添加更多作用域。

$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, ...
        ]
    ]
);

授权流程

<?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();
}

刷新令牌

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

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

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

运行测试

$ ./vendor/bin/phpunit

许可证

MIT 许可证(MIT)。有关更多信息,请参阅 许可证文件