Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vdbelt/oauth2-revolut
https://github.com/vdbelt/oauth2-revolut
oauth2 oauth2-client php revolut
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vdbelt/oauth2-revolut
- Owner: vdbelt
- License: mit
- Created: 2020-02-10T08:37:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-22T12:57:46.000Z (over 2 years ago)
- Last Synced: 2024-10-31T16:27:52.367Z (18 days ago)
- Topics: oauth2, oauth2-client, php, revolut
- Language: PHP
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Revolut Provider for OAuth 2.0 Client
[](https://travis-ci.org/vdbelt/oauth2-revolut)
[](https://github.com/vdbelt/oauth2-revolut/releases)
[](LICENSE.md)
[](https://packagist.org/packages/vdbelt/oauth2-revolut)
This package provides Revolut OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).
## Installation
To install, use composer:
```
composer require vdbelt/oauth2-revolut
```
## Usage
Usage is the same as The League's OAuth client, using `\League\OAuth2\Client\Provider\Revolut` as the provider.
### Generating Key Pairs
Start with generating a key pair as described in the [Revolut API docs](https://revolutdev.github.io/business-api/?shell--sandbox#revolut-api-authentication-setting-up-access-to-your-business-account):
```
openssl genrsa -out privatekey.pem 1024
openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825
```
Upload the public key through the Revolut for Business API Settings page, and store the private key somewhere safe.
### Authorization Code Flow
```php
$provider = new League\OAuth2\Client\Provider\Revolut([
'clientId' => '{revolut-client-id}',
'privateKey' => 'file://{revolut-private-key-path}',
'redirectUri' => 'https://example.com/callback-url' // equal to redirect URI provided to Revolut
'isSandbox' => false
]);
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']
]);
// Store the token somewhere safe. Note that the token is valid for 40 minutes.
// After 40 minutes, you can request a new access token based on the refresh token (valid for 90 days):
if($token->hasExpired()) {
$newToken = $provider->getAccessToken('refresh_token', [
'refresh_token' => $token->getRefreshToken()
]);
}
// Use this to interact with the API on the users behalf
echo $token->getToken();
}
```
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/vdbelt/oauth2-revolut/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Martin van de Belt](https://github.com/vdbelt)
- [All Contributors](https://github.com/vdbelt/oauth2-revolut/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/vdbelt/oauth2-revolut/blob/master/LICENSE) for more information.