Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaasarhan/oauth2-docusign
Docusign OAuth2 Provider for League OAuth2 Client
https://github.com/alaasarhan/oauth2-docusign
docusign docusign-oauth league-oauth2 oauth oauth2 oauth2-client php
Last synced: 23 days ago
JSON representation
Docusign OAuth2 Provider for League OAuth2 Client
- Host: GitHub
- URL: https://github.com/alaasarhan/oauth2-docusign
- Owner: AlaaSarhan
- License: mit
- Created: 2018-11-04T23:40:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T16:07:17.000Z (7 months ago)
- Last Synced: 2024-10-04T06:49:49.414Z (about 1 month ago)
- Topics: docusign, docusign-oauth, league-oauth2, oauth, oauth2, oauth2-client, php
- Language: PHP
- Size: 32.2 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Docusign Provider for OAuth 2.0 Client
[](https://github.com/AlaaSarhan/oauth2-docusign/releases)
[](LICENSE.md)
[](https://scrutinizer-ci.com/g/AlaaSarhan/oauth2-docusign/code-structure)
[](https://scrutinizer-ci.com/g/AlaaSarhan/oauth2-docusign)
[](https://packagist.org/packages/sarhan/oauth2-docusign)
This package provides Docusign 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 sarhan/oauth2-docusign
```
## Usage
Usage is the same as The League's OAuth client, using `\Sarhan\OAuth2\Client\Provider\Docusign` as the provider.
### Authorization Code Flow
```php
$provider = new \Sarhan\OAuth2\Client\Provider\Docusign([
'clientId' => '{docusign-integrator-key}',
'clientSecret' => '{docusign-integrator-key-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->getId());
} 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();
}
```
### Refreshing a Token
```php
$provider = new \Sarhan\OAuth2\Client\Provider\Docusign([
'clientId' => '{docusign-integrator-key}',
'clientSecret' => '{docusign-integrator-key-secret}',
'redirectUri' => 'https://example.com/callback-url'
]);
$token = $provider->getAccessToken('refresh_token', [
'refresh_token' => '{refresh token}'
]);
```
## Vendor specific options
`sandbox`
when passed with `true` to the provider constructor, the provider will direct docuaign endpoint calls to docusign sandbox domain (account-d.docusign.com).
```php
$provider = new \Sarhan\OAuth2\Client\Provider\Docusign([
'clientId' => '{docusign-integrator-key}',
'clientSecret' => '{docusign-integrator-key-secret}',
'redirectUri' => 'https://example.com/callback-url',
'sandbox' => true
]);
```
## Testing
```bash
$ ./vendor/bin/phpunit
```
or
```bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/AlaaSarhan/oauth2-docusign/blob/master/CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](https://github.com/AlaaSarhan/oauth2-docusign/blob/master/LICENSE) for more information.