README

Laravel AmoCrm是针对Laravel 5及以上版本的ServiceProvider和Facade，使用amocrm-php库来提供与amoCRM API的集成。

安装

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

$ composer require dotzero/laravel-amocrm

配置

如果您使用Laravel 5.5及以上版本，则无需注册providers和aliases。

对于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