README

本软件包为 PHP League 的 OAuth 2.0 客户端 提供Bitrix24 OAuth 2.0 支持。

安装

要安装，请使用 composer

composer require batiscaff/oauth2-bitrix24

用法

用法类似于基本 OAuth 客户端，使用 \Batiscaff\OAuth2\Client\Provider\Bitrix24 作为提供者。

授权码流

$provider = new League\OAuth2\Client\Provider\Bitrix24([
    'domain'            => 'https://some-bitrix24-host.com',
    'clientId'          => '{bitrix24-client-id}',
    'clientSecret'      => '{bitrix24-client-secret}',
    '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
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getName());
        printf('Your email: %s', $user->getEmail());

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

管理作用域

在创建您的 Bitrix24 授权 URL 时，您可以指定应用程序可能授权的状态和作用域。

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user','user.userfield','lists','im','iblock'] // array or string;
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

如果都没有定义，则提供者将使用内部默认值。

编写此文档时，以下作用域可用：链接。

• bizproc
• calendar
• call
• catalog
• configuration.import
• contact_center
• crm
• department
• disk
• documentgenerator
• crm.documentgenerator
• entity
• telephony
• im
• imbot
• imopenlines
• intranet
• landing
• lists
• log
• mailservice
• messageservice
• mobile
• pay_system
• placement
• pull
• rpa
• sale
• sonet_group
• task
• timeman
• user
• user_brief
• user_basic
• user.userfield
• userfieldconfig
• userconsent
• landing_cloud
• delivery
• rating
• smile
• iblock
• configuration.import
• salescenter
• cashbox
• forum
• pull_channel

测试

$ ./vendor/bin/phpunit

许可

MIT 许可证 (MIT)。请参阅许可文件获取更多信息。