https://github.com/alyamovsky/amocrm-api-client
PHP-библиотека для работы с АПИ amoCRM
https://github.com/alyamovsky/amocrm-api-client
amocrm api crm
Last synced: 6 months ago
JSON representation
PHP-библиотека для работы с АПИ amoCRM
- Host: GitHub
- URL: https://github.com/alyamovsky/amocrm-api-client
- Owner: alyamovsky
- License: mit
- Created: 2017-11-01T19:43:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-16T11:00:04.000Z (about 6 years ago)
- Last Synced: 2024-02-14T05:21:34.018Z (over 2 years ago)
- Topics: amocrm, api, crm
- Language: PHP
- Homepage:
- Size: 112 KB
- Stars: 15
- Watchers: 2
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# amoCRM PHP API Client
[](https://scrutinizer-ci.com/g/ddlzz/amocrm-api-client/?branch=master) [](https://scrutinizer-ci.com/g/ddlzz/amocrm-api-client/?branch=master) [](https://travis-ci.org/ddlzz/amocrm-api-client) [](https://packagist.org/packages/ddlzz/amocrm-api-client)
Библиотека для работы с АПИ [amoCRM](https://amocrm.ru/).
## Установка
CLI:
```
composer require ddlzz/amocrm-api-client
```
`composer.json`:
```
{
"require": {
"ddlzz/amocrm-api-client": "0.*"
}
}
```
## Быстрый старт
```php
setScheme('http');
// $settings->setDomain('amocrm.saas');
// И передать объект SettingsStorage нашему клиенту
// $request = \ddlzz\AmoAPI\ClientFactory::create($credentials, $settings);
// Создадим модель сущности
$lead = new \ddlzz\AmoAPI\Model\Amo\Lead();
// Заполним модель данными. Формат заполнения такой:
$lead['name'] = 'New lead';
$lead['created_at'] = time(); // Обязательные поля created_at и modified_at будут заполнены
// автоматически, если не указывать их явно
$lead['sale'] = 150000; // Аналог из старого АПИ - price. Вы можете использовать как старые,
// так и новые варианты названия поля. Старые будут преобразованы в новые далее при валидации.
// Из-за того, что для добавления и редактирования разные поля будут являться обязательными,
// валидация и заполнение сущности данными происходит позже, в методе клиента add либо update.
$result = $request->add($lead);
echo $result;
} catch (Exception $e) {
echo $e->getFile() . ': ' . $e->getMessage();
}
```
## Возможности
* Библиотека работает с [новым](https://www.amocrm.ru/developers/content/406/abilities/) API, но понимает также названия полей из старой документации.
* По умолчанию используется домен amocrm.ru, также вы можете [указать](docs/settings.md) домен amocrm.com или dev-сервер amocrm в настройках.
* Пауза между запросами в рамках одного обращения к клиенту.
Сущности, с которыми на данный момент работает библиотека:
* Сделки ([добавление](docs/add_lead.md), [редактирование](docs/update_lead.md))
* Контакты ([добавление](docs/add_contact.md), [редактирование](docs/update_contact.md))
* Компании ([добавление](docs/add_company.md), [редактирование](docs/update_company.md))