stepovenko/laravel-amocrm

为 Laravel 5 提供的 ServiceProvider 和 Facade,用于与 amoCRM API 集成

0.6.0 2018-09-26 11:19 UTC

This package is auto-updated.

Last update: 2024-09-27 00:48:38 UTC


README

Build Status Latest Stable Version License Code Coverage Scrutinizer Code Quality

Laravel AmoCrm 是一个 ServiceProvider 和 Facade,为 Laravel 5 提供 amoCRM API 集成的功能,使用 amocrm-php 库。

安装

使用 Composer,在项目根目录下。

$ composer require stepovenko/laravel-amocrm

配置

如果使用 Laravel 5.5 及以上版本,无需注册 providersaliases

对于 Laravel 5.4.* 及以下版本:安装后,需要将 AmoCrmServiceProvider 添加到 config/app.php 文件的 providers 部分。

'providers' => [
    // ...
    Dotzero\LaravelAmoCrm\AmoCrmServiceProvider::class,
],

为了使用 Facade,需要将 AmoCrm 添加到 config/app.php 文件的 aliases 部分。

'aliases' => [
    // ...
    'AmoCrm' => Dotzero\LaravelAmoCrm\Facades\AmoCrm::class,
],

Laravel AmoCrm 需要指定连接到 amoCRM API 的参数。可以在配置文件中指定这些参数。为此,需要发布配置文件。

$ php artisan vendor:publish

此命令将创建 config/amocrm.php 文件,可以在此文件中指定这些参数。此外,还可以使用 .env 文件中的环境变量。

使用

use Dotzero\LaravelAmoCrm\AmoCrmManager;

Route::get('/', function (AmoCrmManager $amocrm) {
    try {

        /** @var \AmoCRM\Client $client */
        $client = $amocrm->getClient();
        $account = $client->account;

        // или

        /** @var \AmoCRM\Models\Account $account */
        $account = $amocrm->account;

        dd($account->apiCurrent());

    } catch (\Exception $e) {
        abort(400, $e->getMessage());
    }
});

如果您倾向于使用 Facade,以下示例展示了如何进行操作。

use Dotzero\LaravelAmoCrm\Facades\AmoCrm;

Route::get('/', function () {

    /** @var \AmoCRM\Client $client */
    $client = AmoCrm::getClient();

    /** @var \AmoCRM\Helpers\Fields $fields */
    $fields = AmoCrm::getFields();

    /** @var \AmoCRM\Helpers\getB2BFamily $fields */
    $b2bfamily = AmoCrm::getB2BFamily();

});

文档

查看 amocrm-php 库的文档。

许可证

此库在 MIT 许可证下提供: https://open-source.org.cn/licenses/mit-license.php