moab-tech/procore-php-sdk

v0.1.1@alpha 2020-11-18 19:27 UTC

This package is auto-updated.

Last update: 2024-09-25 08:18:45 UTC


README

注意!这是一个正在进行的工程项目。目前只提供了少数几个端点,并且没有测试。请自行承担使用风险。

安装

您可以通过composer安装此包

composer require moab-tech/procore-php-sdk

用法

您可以使用传递给客户端的配置数组以四种不同的方式进行身份验证。

第一种是使用现有的有效访问令牌。

$procore = new MoabTech\Procore\Client([
            'client_id' => 'YOUR-CLIENT-ID',
            'client_secret' => 'YOUR-CLIENT-SECRET',
            'access_token' => 'YOUR-ACCESS-TOKEN',
            'expires_in' => 'OPTIONAL: Should be in seconds'
        ]);
$procoreUser = $procore->me()->show();

如果您没有有效的令牌,但有一个尚未使用的刷新令牌,您可以使用该令牌进行身份验证。请勿在此方法中包含access_token值,否则它将尝试使用该值进行身份验证。

$procore = new MoabTech\Procore\Client([
            'client_id' => 'YOUR-CLIENT-ID',
            'client_secret' => 'YOUR-CLIENT-SECRET',
            'refresh_token' => 'YOUR-ACCESS-TOKEN'
        ]);
$procoreUser = $procore->me()->show();

如果您的应用程序使用客户端凭据授权类型,则可以简单定义类型并传入您的id和密钥。此身份验证方法最适合服务类型请求,而不是用户请求。

$procore = new MoabTech\Procore\Client([
            'grant_type => 'client_credentials',
            'client_id' => 'YOUR-CLIENT-ID',
            'client_secret' => 'YOUR-CLIENT-SECRET'
        ]);
$procoreUser = $procore->me()->show();

请参阅Procore文档以获取通过授权代码授权类型使用的代码。此身份验证方法用于您希望用户使用其Procore用户名和密码对您的应用程序进行身份验证的情况。所有请求都将与该用户关联。请注意,用户只能访问他/她有权限访问的端点。

$procore = new MoabTech\Procore\Client([
            'grant_type => 'authorization_code',
            'client_id' => 'YOUR-CLIENT-ID',
            'client_secret' => 'YOUR-CLIENT-SECRET',
            'code' => 'CODE-YOU-RECEIVED-DURING-AUTHORIZATION',
            'redirect_uri' => 'ie https://example.test/procore/callback'
        ]);
$procoreUser = $procore->me()->show();

测试

即将推出!

变更日志

请参阅变更日志获取有关最近更改的更多信息。

贡献

请参阅贡献指南获取详细信息。

安全漏洞

请查看我们的安全策略了解如何报告安全漏洞。

致谢

许可协议

MIT许可(MIT)。有关更多信息,请参阅许可文件