datlechin/oauth2-sepay

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

v1.0.0 2025-02-24 02:40 UTC

Requires

• php: ^7.4 || ^8.0
• league/oauth2-client: ^2.8

Requires (Dev)

• ext-json: *
• mockery/mockery: ^1.6
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.11

MIT

• Ngo Quoc Dat

• authorization
• Authentication
• client
• oauth
• oauth2
• SePay

README

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

Installation

To install, use composer:

composer require datlechin/oauth2-sepay

Usage

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

Authorization Code Flow

$provider = new \Datlechin\OAuth2\Client\Provider\SePay([
    'clientId' => '{sepay-client-id}',
    'clientSecret' => '{sepay-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->getFullName());
    } 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();
}

Managing Scopes

When creating your SePay authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['profile', 'company', 'bank-account:read'] // array or string; at least 'profile' is required
];

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

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available.

• profile
• company
• bank-account:read
• transaction:read
• webhook:read
• webhook:write
• webhook:delete

Testing

./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

• Ngô Quốc Đạt
• All Contributors

License

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