README

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

Installation

To install, use composer:

composer require anytech/oauth2-vend

Usage

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

Authorization Code Flow

$provider = new Wheniwork\OAuth2\Client\Provider\Vend([
    'clientId'     => '{vend-client-id}',
    'clientSecret' => '{vend-client-secret}',
    'domainPrefix' => '{vend-domain-prefix}',
    '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->state;
    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']
    ]);

    // Vend does not provide a way to get information about the currently
    // authenticated user. (If you know of a way, please let me know!)

    // Use this to interact with an API on the users behalf
    echo $token->accessToken;
}

Refreshing a Token

$provider = new Wheniwork\OAuth2\Client\Provider\Vend([
    'clientId'     => '{vend-client-id}',
    'clientSecret' => '{vend-client-secret}',
    'domainPrefix' => '{vend-domain-prefix}',
    'redirectUri'  => 'https://example.com/callback-url'
]);

$grant = new \League\OAuth2\Client\Grant\RefreshToken();
$token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);