Salesforce Provider for the OAuth 2.0 Client
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src Merge pull request #6 from stevenwadejr/fix/support-18-character-org-ids Feb 3, 2017
tests Update scope test Feb 28, 2017
.gitignore init Oct 5, 2015
.scrutinizer.yml init Oct 5, 2015
.travis.yml
CHANGELOG.md Update changelog Feb 3, 2017
CONTRIBUTING.md init Oct 5, 2015
LICENSE init Oct 5, 2015
README.md Add support to change the base login domain Jul 13, 2016
composer.json Update base package version Jan 26, 2017
phpunit.xml.dist init Oct 5, 2015

README.md

Salesforce Provider for OAuth 2.0 Client

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

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

Installation

To install, use composer:

composer require stevenmaguire/oauth2-salesforce

Usage

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

Authorization Code Flow

$provider = new Stevenmaguire\OAuth2\Client\Provider\Salesforce([
    'clientId'          => '{salesforce-client-id}',
    'clientSecret'      => '{salesforce-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'domain'            => '{custom-salesforce-domain}' // optional, defaults to https://login.salesforce.com
]);

For further usage of this package please refer to the core package documentation on "Authorization Code Grant".

Refreshing a Token

$provider = new Stevenmaguire\OAuth2\Client\Provider\Salesforce([
    'clientId'          => '{salesforce-client-id}',
    'clientSecret'      => '{salesforce-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url'
]);

$existingAccessToken = getAccessTokenFromYourDataStore();

if ($existingAccessToken->hasExpired()) {
    $newAccessToken = $provider->getAccessToken('refresh_token', [
        'refresh_token' => $existingAccessToken->getRefreshToken()
    ]);

    // Purge old access token and store new access token to your data store.
}

Using a custom Salesforce domain

$provider->setDomain('https://foo-bar.salesforce.com');

For further usage of this package please refer to the core package documentation on "Refreshing a Token".

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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