项目作者: ddlzz

项目描述 :
PHP-библиотека для работы с АПИ amoCRM
高级语言: PHP
项目地址: git://github.com/ddlzz/amocrm-api-client.git
创建时间: 2017-11-01T19:43:50Z
项目社区:https://github.com/ddlzz/amocrm-api-client

开源协议:MIT License

下载


amoCRM PHP API Client

Code Coverage Scrutinizer Code Quality Build Status Packagist

Библиотека для работы с АПИ amoCRM.

Установка

CLI:

  1. composer require ddlzz/amocrm-api-client

composer.json:

  1. {
  2. "require": {
  3. "ddlzz/amocrm-api-client": "0.*"
  4. }
  5. }

Быстрый старт

  1. <?php
  2. require __DIR__ . '/../vendor/autoload.php';
  3. $domain = 'testdomain';
  4. $login = 'test@test.com';
  5. $hash = md5('test');
  6. try {
  7. $credentials = new \ddlzz\AmoAPI\CredentialsManager($domain, $login, $hash);
  8. /** @var \ddlzz\AmoAPI\Client $request */
  9. $request = \ddlzz\AmoAPI\ClientFactory::create($credentials);
  10. // Если вы используете другой домен, например amocrm.com, или протокол http,
  11. // например работая с dev-сервером amocrm, можете указать эти параметры в настройках:
  12. // $settings = new \ddlzz\AmoAPI\SettingsStorage();
  13. // $settings->setScheme('http');
  14. // $settings->setDomain('amocrm.saas');
  15. // И передать объект SettingsStorage нашему клиенту
  16. // $request = \ddlzz\AmoAPI\ClientFactory::create($credentials, $settings);
  17. // Создадим модель сущности
  18. $lead = new \ddlzz\AmoAPI\Model\Amo\Lead();
  19. // Заполним модель данными. Формат заполнения такой:
  20. $lead['name'] = 'New lead';
  21. $lead['created_at'] = time(); // Обязательные поля created_at и modified_at будут заполнены
  22. // автоматически, если не указывать их явно
  23. $lead['sale'] = 150000; // Аналог из старого АПИ - price. Вы можете использовать как старые,
  24. // так и новые варианты названия поля. Старые будут преобразованы в новые далее при валидации.
  25. // Из-за того, что для добавления и редактирования разные поля будут являться обязательными,
  26. // валидация и заполнение сущности данными происходит позже, в методе клиента add либо update.
  27. $result = $request->add($lead);
  28. echo $result;
  29. } catch (Exception $e) {
  30. echo $e->getFile() . ': ' . $e->getMessage();
  31. }

Возможности

  • Библиотека работает с новым API, но понимает также названия полей из старой документации.
  • По умолчанию используется домен amocrm.ru, также вы можете указать домен amocrm.com или dev-сервер amocrm в настройках.
  • Пауза между запросами в рамках одного обращения к клиенту.

Сущности, с которыми на данный момент работает библиотека: