Skip to content

jiminny/oauth2-aircall

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aircall Provider for OAuth 2.0 Client

This package provides Aircall OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require jiminny/oauth2-aircall

Usage

Usage is the same as The League's OAuth client, using \Jiminny\OAuth2\Client\Provider\Aircall as the provider.

Authorization Code Flow

$provider = new Jiminny\OAuth2\Client\Provider\Aircall([
    'clientId'          => '{aircall-client-id}',
    'clientSecret'      => '{aircall-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'host'              => 'https://api.aircall.io' // Defaults to https://api.aircall.io
]);

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

The Aircall API supports refresh tokens. Review the "Refreshing a Token documentation" on the base oauth2-client project for tips on implementing refresh tokens in your project.

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages