sergey178/laravel-amocrm

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

v0.7.1 2019-09-07 08:54 UTC

This package is auto-updated.

Last update: 2024-09-07 19:52:34 UTC


README

Build Status Latest Stable Version License Code Coverage Scrutinizer Code Quality

Laravel AmoCrm 是一个 ServiceProvider 和 Facade,用于 Laravel 5,通过使用 amocrm-php 库来提供与 amoCRM API 的集成。

安装

使用 Composer 在项目根目录下。

$ composer require dotzero/laravel-amocrm

配置

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

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

'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