slowprog / oauth2-modulbank
Modulbank Provider for the OAuth 2.0 Client
1.0.0
2016-07-18 14:05 UTC
Requires
- php: >=5.5.0
- league/oauth2-client: ~1.4
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-11-05 19:12:32 UTC
README
This package provides Modulbank OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require slowprog/oauth2-modulbank
Usage
Usage is the same as The League's OAuth client, using \League\OAuth2\Client\Provider\Modulbank
as the provider.
Authorization Code Flow
$provider = new \League\OAuth2\Client\Provider\Modulbank([ 'clientId' => '{modulbank-client-id}', 'clientSecret' => '{modulbank-client-secret}', 'redirectUri' => 'https://example.com/callback-url', 'debug' => false ]); // Get url for registration which must transfer to browser (send GET) // $url = $provider->getRegistrationUrl($firstName, $lastName, $email, $cellPhone); // Or // Get url for authorization which must transfer to browser (send POST) $url = $provider->getAuthorizationUrlShort(); $params = $provider->getAuthorizationParams([ 'scope' => 'account-info operation-history assistant-service money-transfer', ]);
Callback file:
$provider = new \League\OAuth2\Client\Provider\Modulbank([ 'clientId' => '{modulbank-client-id}', 'clientSecret' => '{modulbank-client-secret}', 'debug' => false ]); $token = $provider->getAccessToken('authorization_code', [ 'code' => $code ]); // Use this to interact with an API on the users behalf echo $token->getToken();
Call methods
$provider = new \League\OAuth2\Client\Provider\Modulbank([ 'clientId' => '{modulbank-client-id}', 'clientSecret' => '{modulbank-client-secret}', 'token' => '{modulbank-client-token}', 'debug' => false ]); $info = $provider->getAccountInfo(); // $history = $provider->getOperationHistory('9f65fff4-d638-41d8-83eb-a616039d3fe5'); // $balance = $provider->getBalance('9f65fff4-d638-41d8-83eb-a616039d3fe5');
Managing Scopes
When creating your Modulbank authorization URL, you can specify the state and scopes your application may authorize.
$params = $provider->getAuthorizationParams([ 'scope' => 'assistant-service money-transfer', ]);
If neither are defined, the provider will utilize internal defaults.
At the time of authoring this documentation, the following scopes are available.
- account-info
- operation-history
- assistant-service
- money-transfer
License
The MIT License (MIT). Please see License File for more information.