Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/compwright/oauth2-servicefusion

Service Fusion OAuth 2.0 support for the PHP League's OAuth 2.0 Client
https://github.com/compwright/oauth2-servicefusion

oauth2 oauth2-provider servicefusion

Last synced: about 6 hours ago
JSON representation

Service Fusion OAuth 2.0 support for the PHP League's OAuth 2.0 Client

Awesome Lists containing this project

README

        

# Service Fusion Provider for OAuth 2.0 Client

[![Latest Version](https://img.shields.io/github/release/compwright/oauth2-servicefusion.svg?style=flat-square)](https://github.com/compwright/oauth2-servicefusion/releases)
[![Build Status](https://app.travis-ci.com/compwright/oauth2-servicefusion.svg?branch=master)](https://app.travis-ci.com/github/compwright/oauth2-servicefusion)
[![Total Downloads](https://img.shields.io/packagist/dt/compwright/oauth2-servicefusion.svg?style=flat-square)](https://packagist.org/packages/compwright/oauth2-servicefusion)

This package provides Service Fusion 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 compwright/oauth2-servicefusion league/oauth2-client
```

## Usage

Usage is the same as The League's OAuth client, using `\Compwright\OAuth2_Servicefusion\Provider` as the provider.

### Example: Authorization Code Flow

```php
$provider = new Compwright\OAuth2_Servicefusion\Provider([
'clientId' => '{servicefusion-client-id}',
'clientSecret' => '{servicefusion-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
if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
}

// Get an access token using the authorization code grant
$token = $provider->getAccessToken('authorization_code', [
'code' => $_GET['code']
]);

// You can look up a users profile data
$user = $provider->getResourceOwner($token);
printf('Hello %s!', $user->getId());

// Use the token to interact with an API on the users behalf
echo $token->getToken();
```

## Testing

```bash
$ make test
```

## Contributing

Please see [CONTRIBUTING](https://github.com/compwright/oauth2-servicefusion/blob/master/CONTRIBUTING.md) for details.

## Credits

- [Jonathon Hill](https://github.com/compwright)
- [All Contributors](https://github.com/compwright/oauth2-servicefusion/contributors)

## License

The MIT License (MIT). Please see [License File](https://github.com/compwright/oauth2-servicefusion/blob/master/LICENSE) for more information.