flipboxdigital/oauth2-salesforce

为 PHP League OAuth2-Client 提供的 Salesforce OAuth 2.0 客户端提供商

1.0.0 2018-02-22 21:06 UTC

This package is auto-updated.

Last update: 2024-09-09 13:11:41 UTC


README

Join the chat at https://gitter.im/flipbox/oauth2-salesforce Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

此软件包为 PHP League 的 OAuth 2.0 客户端 提供Salesforce OAuth 2.0 支持。

安装

要安装,请使用 composer

composer require flipboxdigital/oauth2-salesforce

使用方法

使用方法与 The League 的 OAuth 客户端相同,使用 \Flipbox\OAuth2\Client\Provider\Salesforce 作为提供商。

授权码流

$provider = new Flipbox\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
    'apiVersion'        => '{custom-salesforce-api-version}' // optional, defaults to v21.0
]);

有关此软件包的进一步使用,请参阅 核心软件包文档中的“授权码授予”部分

刷新令牌

$provider = new Flipbox\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.
}

使用自定义 Salesforce 域

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

有关此软件包的进一步使用,请参阅 核心软件包文档中的“刷新令牌”部分

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息,请参阅 CONTRIBUTING

致谢

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。