Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotzero/laravel-amocrm
An amoCRM bridge for Laravel 5, 6 and 7
https://github.com/dotzero/laravel-amocrm
amocrm laravel php
Last synced: 2 months ago
JSON representation
An amoCRM bridge for Laravel 5, 6 and 7
- Host: GitHub
- URL: https://github.com/dotzero/laravel-amocrm
- Owner: dotzero
- License: mit
- Created: 2016-11-13T17:13:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T15:27:13.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T05:52:37.834Z (3 months ago)
- Topics: amocrm, laravel, php
- Language: PHP
- Homepage: https://github.com/dotzero/laravel-amocrm
- Size: 29.3 KB
- Stars: 31
- Watchers: 6
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel AmoCrm
[![Build Status](https://travis-ci.org/dotzero/laravel-amocrm.svg?branch=master)](https://travis-ci.org/dotzero/laravel-amocrm)
[![Latest Stable Version](https://poser.pugx.org/dotzero/laravel-amocrm/version)](https://packagist.org/packages/dotzero/laravel-amocrm)
[![License](https://poser.pugx.org/dotzero/laravel-amocrm/license)](https://packagist.org/packages/dotzero/laravel-amocrm)
[![Code Coverage](https://scrutinizer-ci.com/g/dotzero/laravel-amocrm/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/dotzero/laravel-amocrm/?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dotzero/laravel-amocrm/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dotzero/laravel-amocrm/?branch=master)**Laravel AmoCrm** это ServiceProvider и Facade для **Laravel 5 и выше** предоставляющие интеграцию с API amoCRM используя библиотеку [amocrm-php](https://github.com/dotzero/amocrm-php).
## Установка
Используя [Composer](https://getcomposer.org/), в корнерой директории проекта.
```bash
$ composer require dotzero/laravel-amocrm
```## Настройка
Если вы используете Laravel 5.5 и выше, регистрировать `providers` и `aliases` не нужно.
Для Laravel 5.4.* и ниже: после установки необходимо добавить `AmoCrmServiceProvider` в секцию `providers` файла `config/app.php`.
```php
'providers' => [
// ...
Dotzero\LaravelAmoCrm\AmoCrmServiceProvider::class,
],
```Для использования [Facade](http://laravel.com/docs/facades), необходимо добавить `AmoCrm` в секцию `aliases` файла `config/app.php`.
```php
'aliases' => [
// ...
'AmoCrm' => Dotzero\LaravelAmoCrm\Facades\AmoCrm::class,
],
```Laravel AmoCrm требует указания параметров подключения к API amoCRM. Указать их можно в файле конфигурации. Для этого необходимо опубликовать файл конфигурации.
```bash
$ php artisan vendor:publish
```Эта команда создаст файл `config/amocrm.php` в котором можно будет указать эти параметры. Кроме того можно использовать переменные окружения используя файл `.env`.
## Использование
```php
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, то следующий пример показывает как это можно сделать.
```php
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](https://github.com/dotzero/amocrm-php).
## Лицензия
Библиотека доступна на условиях лицензии MIT: http://www.opensource.org/licenses/mit-license.php