README

This package provide Bitrix24 OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require juliaaan1/oauth2-bitrix24

Usage

Usage is the same as The League's OAuth client, using \Juliaaan1\OAuth2\Client\Provider\Bitrix24 as the provider.

Obtaining Client ID and Client Secret from Bitrix24

1. Navigate to the Developer section (/devops/).
2. Create a new local application (Other -> Local application).
3. Fill in the application details:
   • Application type: Select Server
   • Handler path: Enter the full URL to the callback route on your server.
   • Script only (no user interface)
   • Assign permissions: Users (minimum) (user_brief)

Note

The Handler path defines the redirect_uri used in the OAuth flow.

1. Save the application. After saving, the page will display your Client ID and Client Secret.

Authorization Code Flow

$provider = new \Juliaaan1\OAuth2\Client\Provider\Bitrix24([
    'clientId' => '{bitrix24-client-id}',
    'clientSecret' => '{bitrix24-client-secret}',
    'bitrix24domain' => '{bitrix24-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->getId());
    } catch (Exception $e) {
        // Failed to get user details
        exit($e->getMessage());
    }
    
    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Testing

./vendor/bin/phpunit

License

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