digitalgdn/oauth2-sheepcrm

SheepCRM OAuth 2.0 support for the PHP League's OAuth 2.0 Client

dev-main 2025-07-18 18:19 UTC

Requires

• league/oauth2-client: ^2.8

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0

MIT

• Ben Knowles

• php
• authorization
• Authentication
• client
• oauth
• oauth2
• sheepcrm

README

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

Installation

composer require DigitalGdn/oauth2-sheepcrm

Usage

$sheepProvider = new \DigitalGdn\OAuth2\Client\Provider\Sheep([
    'clientId'     => 'yourId',          // The client ID assigned to you by sheepCRM
    'clientSecret' => 'yourSecret',      // The client password assigned to you by sheepCRM
    'redirectUri'  => 'yourRedirectUri'  // The return URL you specified for your app on sheepCRM
]);

// Get authorization code
if (!isset($_GET['code'])) {
    // Options are optional, defaults shown below
    $options = ['scope' => ['read', 'write', 'read_membership', 'introspection']];
    // Get authorization URL
    $authorizationUrl = $sheepProvider->getAuthorizationUrl($options);

    // Get state and store it to the session
    $_SESSION['oauth2state'] = $sheepProvider->getState();

    // Redirect user to authorization URL
    header('Location: ' . $authorizationUrl);
    exit;
// Check for errors
} elseif (empty($_GET['state']) || (isset($_SESSION['oauth2state']) && $_GET['state'] !== $_SESSION['oauth2state'])) {
    if (isset($_SESSION['oauth2state'])) {
        unset($_SESSION['oauth2state']);
    }
    exit('Invalid state');
} else {
    // Get access token
    try {
        $accessToken = $sheepProvider->getAccessToken(
            'authorization_code',
            [
                'code' => $_GET['code']
            ]
        );
    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
        exit($e->getMessage());
    }

    // Get resource owner
    try {
        $resourceOwner = $sheepProvider->getResourceOwner($accessToken);
    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
        exit($e->getMessage());
    }

    // Now you can store the results to session etc.
    $_SESSION['accessToken'] = $accessToken;
    $_SESSION['resourceOwner'] = $resourceOwner;

    var_dump(
        $resourceOwner->getId(),
        $resourceOwner->getUsername(),
        $resourceOwner->getFirstName(),
        $resourceOwner->getLastName(),
        $resourceOwner->getName(),
        $resourceOwner->getEmail(),
        $resourceOwner->getActiveMember(),
        $resourceOwner->toArray()
    );
}

For more information see the PHP League's general usage examples.

Testing

$ ./vendor/bin/phpunit

License

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