README

为PHP提供简单的CleverReach v3集成

• 要求
• 安装
• 原始文档
• 用法
  • Laravel
  • PHP
• 测试
• 问题
• 许可
• 待办事项

要求

安装

Packagist

• 您可以通过composer安装此包

composer require "baorv/cleverreach":"^0.0.1"

• 或通过 composer.json 方式

{
  "require": {
    "baorv/cleverreach": "^0.0.1"
  }
}

然后运行

composer update "baorv/cleverreach"

Laravel版本

• 将 ServiceProvider 添加到 config/app.php

Baorv\Cleverreach\ServiceProvider::class

• 更改.env中的环境变量

CLEVERREACH_CLIENT_ID=
CLEVERREACH_CLIENT_SECRET=
CLEVERREACH_ACCESS_TOKEN=

• 如果您想自定义 配置。您还可以发布配置文件

php artisan vendor:publish --provider="Baorv\\CleverReach\ServiceProvider"

原始文档

CleverReach原始文档位于 https://rest.cleverreach.com/explorer/v3/

用法

PHP

• 用于验证CleverReach

<?php

use Baorv\CleverReach\Http\GuzzleHttpClient;

$cleverReachApi = new GuzzleHttpClient('client_id', 'client_secret');
$cleverReachApi->authorize();

// Get access token
$accessToken = $cleverReachApi->getAccessToken();

• 用于从CleverReach服务器访问资源

<?php

use Baorv\CleverReach\Resources\Endpoints\Debug;

/** @var \Baorv\CleverReach\Http\GuzzleHttpClient $cleverReachApi */
$debugApi = new Debug($cleverReachApi);

$debugApi->exchange();

Laravel

• 用于从CleverReach API访问资源

<?php

use Baorv\CleverReach\Resources\Endpoints\Reports;

app(Reports::class)->all();

异常

当您请求CleverReach API时，它可能包含一些错误。

• 为了捕获异常，我们提供了 CleverReachException

<?php

use Baorv\CleverReach\Resources\Endpoints\Reports;
use Baorv\CleverReach\Exceptions\CleverReachException;

try {
    app(Reports::class)->all();
} catch (CleverReachException $ex) {
    // Log or do something with $ex
}

• 另外，对于PHP

<?php

use Baorv\CleverReach\Resources\Endpoints\Reports;
use Baorv\CleverReach\Exceptions\CleverReachException;

/** @var \Baorv\CleverReach\Http\GuzzleHttpClient $cleverReachApi */
$reportApi = new Reports($cleverReachApi);

try {
    $reportApi->all();
} catch (CleverReachException $ex) {
    // Log or do anything with $ex
}

测试

问题

如果您有任何问题，请 创建新问题

许可

本项目采用MIT许可。

待办事项

• 添加缺失的资源
• 制作更好的文档
• 测试