Skip to content

MYOB OAuth 2.0 Client Provider for The PHP League OAuth2-Client

License

Notifications You must be signed in to change notification settings

tenfef/oauth2-myob

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MYOB Provider for OAuth 2.0 Client

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

Installation

To install, use composer:

composer require 'tenfef/oauth2-myob:dev-master'

Usage

Usage is the same as The League's OAuth client, using Tenfef\MYOB\Provider as the provider.

Authorization Code Flow

$provider = new Tenfef\MYOB\Provider([
    'clientId'     => '{myob-client-id}',
    'clientSecret' => '{myob-client-secret}',
    'domainPrefix' => '{myob-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']
    ]);

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

Refreshing a Token

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

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

Fetching company files from Account Right

    $provider = new Tenfef\MYOB\Provider([
		'clientId'      => 'xxxxxxxxx',
		'clientSecret'  => 'xxxxxxxxx',
		'redirectUri'   => 'https://example.com',
		'scopes'        => ['la.global CompanyFile']
	]);

	$token = 'xxxxxxxxx';

	$request = new Tenfef\MYOB\AccountRight($provider, $token);
	echo json_encode($request->companyFiles());

Hat tip to the Vend OAuth Provider which gave a good template for this Provider. https://github.com/wheniwork/oauth2-vend

About

MYOB OAuth 2.0 Client Provider for The PHP League OAuth2-Client

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages