https://github.com/wheniwork/oauth2-square
Square provider for the OAuth 2.0 Client
https://github.com/wheniwork/oauth2-square
Last synced: 5 months ago
JSON representation
Square provider for the OAuth 2.0 Client
- Host: GitHub
- URL: https://github.com/wheniwork/oauth2-square
- Owner: wheniwork
- License: mit
- Created: 2015-02-23T02:55:57.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T12:50:21.000Z (about 2 years ago)
- Last Synced: 2025-03-03T22:24:59.143Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 29
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Square Provider for OAuth 2.0 Client
[](https://travis-ci.org/wheniwork/oauth2-square)
[](https://coveralls.io/r/wheniwork/oauth2-square)
[](https://scrutinizer-ci.com/g/wheniwork/oauth2-square/)
[](https://github.com/wheniwork/oauth2-square/blob/master/LICENSE)
[](https://packagist.org/packages/wheniwork/oauth2-square)
This package provides Square 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 wheniwork/oauth2-square
```
## Usage
Usage is the same as The League's OAuth client, using `Wheniwork\OAuth2\Client\Provider\Square` as the provider.
To make requests against the Square staging server, pass `'debug' => true` as part of the initial configuration options.
### Authorization Code Flow
```php
$provider = new Wheniwork\OAuth2\Client\Provider\Square([
'clientId' => '{square-client-id}',
'clientSecret' => '{square-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->state;
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
$userDetails = $provider->getUserDetails($token);
// Use these details to create a new profile
printf('Hello %s!', $userDetails->firstName);
} catch (Exception $e) {
// Failed to get user details
exit('Oh dear...');
}
// Use this to interact with an API on the users behalf
echo $token->accessToken;
}
```
## Refreshing a Token
Square does not provide refresh tokens. Instead, an access token can be "renewed"
up to 15 days after it expires. To accomdate this, the Square provider provides
an additional grant, `RenewToken`.
```php
$provider = new Wheniwork\OAuth2\Client\Provider\Square([
'clientId' => '{square-client-id}',
'clientSecret' => '{square-client-secret}',
'redirectUri' => 'https://example.com/callback-url'
]);
$token = $provider->getAccessToken('renew_token', ['access_token' => $accessToken]);
```
This grant can also be used by injecting the `AccessToken` instance directly,
instead of providing a parameter to `getAccessToken`:
```php
$grant = new Wheniwork\OAuth2\Client\Grant\RenewToken($token);
$token = $provider->getAccessToken($grant);
```