timenomad / getresponse-v3-api
GetResponse V3 API 的 PHP 封装,支持 OAuth2 授权流程
1.1.0
2016-05-23 11:51 UTC
Requires
- php: >=5.3.0
- ext-curl: *
README
GetResponse V3 API 的只读 PHP 封装,支持 OAuth2 授权流程。
创建 GetResponse 应用
- 您需要在以下位置创建应用: https://app.getresponse.com/manage_api.html(第三方应用)
- 请注意 Client ID 和 Client Secret,您将需要它们。
- 设置重定向 URL 为您的 Web 应用路由,该路由负责在用户批准授予您的应用访问权限后获取访问令牌。
用法
- 通过 composer 安装:
composer require timenomad/getresponse-v3-api - 初始化 API 对象:
$getResponse = new \Timenomad\GetResponseV3Api("*Client ID*", "*Client Secret*", "*State*");。
State 只是一个随机的字符组合,用于验证回调的来源。它是一个静态值。
例如:fdsfjhs3SDGg23refsd2u09@$ - 获取 OAuth2 用户同意 URL:
$getResponse->getOAuthConsentUrl() - 当用户批准并且您的回调 URL 被调用时:
$accessToken = $getResponse->getAccessToken(); - 将令牌存储在您的存储引擎中
- 拥有令牌后,我们现在可以配置身份验证并开始调用 API
$getResponse->setAccessToken($token['access_token']);
$getResponse->setAccessTokenExpiryCallback($token['refresh_token'], function($newTokenData) {
// 访问令牌已过期。此函数将在生成新令牌后调用。
// 在这里,您可以将新令牌数据保存到数据库或任何其他存储方式。
}); - 我们现在可以调用 API!
$userInfo = $getResponse->getAccountInfo();
$campaigns = $getResponse->getCampaigns();
$statistics = $getResponse->getCampaignStatistics();
SSL 验证
出于开发目的,禁用 curl 的 SSL 证书验证可能很有用,为此,请以如下方式实例化 API 封装对象(第 4 个参数设置为绕过验证)
GetResponseV3Api(x, y, z, true)