Download the PHP package livevasiliy/amocrm-api-library without Composer

amoCRM API Library

Данный репозитории является форком официальным для старых версии PHP

Если вы работаете с более новыми версиями, пожалуйста, используйте официальный репозиторий

В данном пакете представлен API клиент с поддержкой основных сущностей и авторизацией по протоколу OAuth 2.0 в amoCRM. Для работы библиотеки требуется PHP версии не ниже 5.6.

Оглавление

• Установка
• Начало работы
• Подход к работе с библиотекой
• Поддерживаемые методы и сервисы
• Обработка ошибок
• Фильтры
• Работа с Custom Fields сущностей
• Работа с тегами сущностей
• Особенности работы с источниками
• Константы
• Работа в случае смены субдомена аккаунта
• Одноразовые токены интеграций, расшифровка
• Примеры

Установка

Установить библиотеку можно с помощью composer:

Начало работы и авторизация

Для начала использования вам необходимо создать объект библиотеки:

Также предоставляется фабрика для создания объектов \AmoCRM\Client\AmoCRMApiClientFactory. Для ее использования вам нужно реализовать интерфейс \AmoCRM\OAuth\OAuthConfigInterface и \AmoCRM\OAuth\OAuthServiceInterface

При использовании фабрики вам не нужно устанавливать callback onAccessTokenRefresh, при обновлении токена будет вызван метод saveOAuthToken из $oAuthService (\AmoCRM\OAuth\OAuthServiceInterface).

Затем необходимо создать объект (\League\OAuth2\Client\Token\AccessToken) Access токена из вашего хранилища токенов и установить его в API клиент.

Также необходимо установить домен аккаунта amoCRM в виде СУБДОМЕН.amocrm.(ru/com).

Вы можете установить функцию-callback на событие обновления Access токена, если хотите дополнительно обрабатывать новый токен (например сохранять его в хранилище токенов):

Отправить пользователя на страницу авторизации можно 2мя способами:

1. Отрисовав кнопку на сайт:

2. Отправив пользователя на страницу авторизации

Для получения Access Token можно использовать следующий код в обработчике, который будет находиться по адресу, указанному в redirect_uri

Пример авторизации можно посмотреть в файле examples/get_token.php

Подход к работе с библиотекой

В библиотеке используется сервисный подход. Для каждой сущности имеется сервис. Для каждого метода имеется свой объект коллекции и модели. Работа с данными происходит через коллекции и методы библиотеки.

Модели и коллекции имеют методы и , методы возвращают представление объекта в виде массива и в виде данных, отправляемых в API.

Также для работы с коллекциями имеются следующие методы:

1. • добавляет модель в конец коллекции.
2. • добавляет модель в начало коллекции.
3. • возвращает массив моделей в коллекции.
4. • получение первой модели в коллекции.
5. • получение последней модели в коллекции.
6. • получение кол-ва элементов в коллекции.
7. • проверяет, что коллекция не пустая.
8. • получение модели по значению ключа.
9. • замена модели по значению ключа.
10. • удаление моделей по значению ключа, возвращает количество удаленных моделей.
11. • удаление первой модели по значению ключа, возвращает true если модель была удалена.
12. • разделение коллекции на массив состоящий из коллекций определенной длины.
13. • получение массива значений моделей коллекции по названию свойства.

При работе с библиотекой необходимо не забывать о лимитах API amoCRM. Для оптимальной работы с данными лучше всего создавать/изменять за раз не более 50 сущностей в методах, где есть пакетная обработка.

Нужно не забывать про обработку ошибок, а также не забывать о безопасности хранилища токенов. Утечка токена грозит потерей доступа к аккаунту.

Поддерживаемые методы и сервисы

Библиотека поддерживает большое количество методов API. Методы сгруппированы в объекты-сервисы. Получить объект сервиса можно вызвав необходимый метод у библиотеки, например:

В данный момент доступны следующие сервисы:

Для большинства сервисов есть базовый набор методов:

1. getOne - Получить 1 сущность

   1. id (int|string) - id сущности
   2. with (array) - массив параметров with, которые поддерживает модель сервиса
   3. Результатом выполнения будет модель сущности

2. get Получить несколько сущностей:

   1. filter (BaseEntityFilter) - фильтр для сущности
   2. with (array) - массив параметров with, которые поддерживает модель сервиса
   3. Результатом выполнения будет коллекция сущностей

3. addOne Создать одну сущность:

   1. model (BaseApiModel) - модель создаваемой сущности
   2. Результатом выполнения будет модель сущности

4. add Создать сущности пакетно:

   1. collection (BaseApiCollection) - коллекция моделей создаваемой сущности
   2. Результатом выполнения будет коллекция моделей сущности

5. updateOne Обновить одну сущность:

   1. model (BaseApiModel) - модель создаваемой сущности
   2. Результатом выполнения будет модель сущности

6. update Обновить сущности пакетно:

   1. collection (BaseApiCollection) - коллекция моделей создаваемой сущности
   2. Результатом выполнения будет коллекция моделей сущности
7. syncOne Синхронизировать одну модель с сервером:
   1. model (BaseApiModel) - коллекция моделей создаваемой сущности
   2. with (array) - массив параметров with, которые поддерживает модель сервиса
   3. Результатом выполнения будет коллекция моделей сущности

Не все методы доступны во всех сервисах. В случае их вызова будет выброшены Exception.

Некоторые сервисы имеют специфичные методы, ниже рассмотрим сервисы, которые имеют специфичные методы.

Методы доступные в сервисе :

1. addComplex Создать сделки пакетно со связанным контакт и компанией через комплексный метод с поддержкой контроля дублей

   1. collection (LeadsCollection) - коллекция моделей создаваемой сущности
   2. Результатом выполнения будет новая коллекция созданных сущностей
2. addOneComplex Создать одну сделку со связанным контакт и компанией через комплексный метод с поддержкой контроля дублей
   1. collection (LeadsCollection) - коллекция моделей создаваемой сущности
   2. Результатом выполнения будет новая модель созданной сделки

Подробнее про использование метода комплексного создания смотрите в примере

Методы доступные в сервисе :

1. getAuthorizeUrl получение ссылки на авторизация

   1. options (array)
      1. state (string) состояние приложения
   2. Результатом выполнения будет строка со ссылкой на авторизация приложения

2. getAccessTokenByCode получение access токена по коду авторизации

   1. code (string) код авторизации
   2. Результатом выполнения будет объект (AccessTokenInterface)

3. getAccessTokenByRefreshToken получение access токена по refresh токену

   1. accessToken (AccessTokenInterface) объект access токена
   2. Результатом выполнения будет объект (AccessTokenInterface)

4. setBaseDomain установка базового домена, куда будут отправляться запросы необходимые для работы с токенами

   1. domain (string)

5. setAccessTokenRefreshCallback установка callback, который будет вызван при обновлении access токена

   1. function (callable)

6. getOAuthButton установка callback, который будет вызван при обновлении access токена

   1. options (array)
      1. state (string) состояние приложения
      2. color (string)
      3. title (string)
      4. compact (bool)
      5. class_name (string)
      6. error_callback (string)
      7. mode (string)
   2. Результатом выполнения будет строка с HTML кодом кнопки авторизации
7. exchangeApiKey метод для обмена API ключа на код авторизации
   1. login - email пользователя, для которого обменивается API ключ
   2. apiKey - API ключ пользователя
   3. Код авторизации будет прислан на указанный в настройках приложения redirect_uri

Методы связей доступны в сервисах , , , :

1. link Привязать сущность

   1. model (BaseApiModel) - модель главной сущности
   2. links (LinksCollection|LinkModel) - коллекция или модель связи
   3. Результатом выполнения является коллекция связей (LinksCollection)

2. getLinks Получить связи сущности

   1. model (BaseApiModel) - модель главной сущности
   2. filter (LinksFilter) - фильтр для связей
   3. Результатом выполнения является коллекция связей (LinksCollection)
3. unlink Отвязать сущность
   1. model (BaseApiModel) - модель главной сущности
   2. links (LinksCollection|LinkModel) - коллекция или модель связи
   3. Результатом выполнения является bool значение

Методы удаления доступны в сервисах , , , , , , , :

1. delete

   1. model (BaseApiModel) - модель сущности
   2. Результатом выполнения является bool значение
2. deleteOne
   1. collection (BaseApiCollection) - коллекция моделей сущностей
   2. Результатом выполнения является bool значение

Методы доступные в сервисе :

1. setMode Смена режима покупателей (периодические покупки или сегментация). Если покупатели выключены - то они будут включены.
   1. mode (string) - тип режима (periodicity или segments)
   2. isEnabled (bool) - включен ли функционал покупателей, по-умолчанию - true
   3. Результатом выполнения является строка названия включенного режима или null в случае отключения функционала

Методы доступные в сервисе :

1. earnPoints Начисляет бонусные баллы покупателю

   1. model (BonusPointsActionModel) - модель в которой Id покупателя и количество баллов для начисления
   2. Результатом выполнения является обновленное количество бонусных баллов покупателя или null в случае если произошла ошибка
2. redeemPoints Списывает бонусные баллы покупателя
   1. model (BonusPointsActionModel) - модель в которой Id покупателя и количество баллов для списания
   2. Результатом выполнения является обновленное количество бонусных баллов покупателя или null в случае если произошла ошибка

Методы доступные в сервисе , :

1. getByParentId Получение данных по ID родительской сущности
   1. parentId - ID родительской сущности
   2. filter (BaseEntityFilter) - фильтр
   3. with (array) - массив параметров with, которые поддерживает модель сервиса

Методы доступные в сервисе

1. getCurrent
   1. with (array) - массив параметров with, которые поддерживает модель сервиса
   2. Результатом выполнения является модель AccountModel

Методы доступные в сервисе

1. addOne Создать одну сущность:

   1. model (BaseApiModel) - модель создаваемой сущности
   2. Результатом выполнения будет модель сущности

2. add Создать сущности пакетно:

   1. collection (BaseApiCollection) - коллекция моделей создаваемой сущности
   2. Результатом выполнения будет коллекция моделей сущности

3. link

   1. model (BaseApiModel) - модель неразобранного
   2. body (array) - массив дополнительной информации для привязки
   3. Результатом выполнения будет модель LinkUnsortedModel

4. accept

   1. model (BaseApiModel) - модель неразобранного
   2. body (array) - массив дополнительной информации для принятия
   3. Результатом выполнения будет модель AcceptUnsortedModel

5. decline

   1. model (BaseApiModel) - модель неразобранного
   2. body (array) - массив дополнительной информации для отклонения
   3. Результатом выполнения будет модель DeclineUnsortedModel
6. summary
   1. filter (BaseEntityFilter) - фильтр для сущности
   2. Результатом выполнения будет модель UnsortedSummaryModel

Методы доступные в сервисе

1. subscribe

   1. model (WebhookModel) - модель вебхука
   2. Результатом выполнения является модель WebhookModel
2. unsubscribe
   1. model (WebhookModel) - модель вебхука
   2. Результатом выполнения является bool значение

Методы доступные в сервисе

1. install

   1. model (WidgetModel) - модель виджета
   2. Результатом выполнения является модель WidgetModel
2. uninstall
   1. model (WidgetModel) - модель виджета
   2. Результатом выполнения является модель WidgetModel

Методы доступные в сервисе

1. settings

   1. Результатом выполнения является модель ProductsSettingsModel
2. updateSettings
   1. model (ProductsSettingsModel) - модель виджета
   2. Результатом выполнения является модель ProductsSettingsModel

Методы, доступные в сервисе

1. close
   1. model (TalkCloseActionModel) - модель для закрытия беседы
   2. Результатом выполнения - является закрытие беседы или запуск NPS-бота для последующего закрытия беседы

Обработка ошибок

Вызов методов библиотеки может выбрасывать ошибки типа . В данные момент доступны следующие типы ошибок, они все наследуют AmoCRMApiException:

У выброшенных Exception есть следующие методы:

У ошибки типа AmoCRMApiErrorResponseException есть метод , который вернет ошибки валидации входных данных.

Фильтры

В данный момент библиотека поддерживает фильтры для следующих сервисов:

Работа с дополнительными полями сущностей

Дополнительные поля доступны у сущностей следующих сервисов:

У моделей, которые возвращаются этими сервисами, поля можно получить через метод . На вызов данного метода возвращается объект или , если значений полей нет.

Внутри коллекции находятся модели значений полей, все модели наследуются от , но зависят от типа поля.

У моделей, наследующих доступны следующие методы:

1. , - получение/установка id поля
2. • получение типа поля
3. , - получение/установка кода поля
4. , - получение/установка названия поля
5. , setValues - получение/установка коллекции значений

Так как некоторые поля могут иметь несколько значений, в свойстве values хранится именно коллекция значений типа BaseCustomFieldValueCollection. Моделями коллекции являются модели типа BaseCustomFieldValueModel.

Схема отношений объектов:

CustomFieldsValuesCollection 1 <---> n BaseCustomFieldValuesModel

BaseCustomFieldValuesModel::getValues() 1 <---> 1 BaseCustomFieldValueCollection

BaseCustomFieldValueCollection 1 <---> n BaseCustomFieldValueModel

Для разных типов полей мы уже подготовили разные модели и коллекции:

Namespace, в котором находятся модели значения - \AmoCRM\Models\CustomFieldsValues\ValueModels

Namespace, в котором находятся коллекции моделей значения - \AmoCRM\Models\CustomFieldsValues\ValueCollections

Namespace, в котором находятся модели дополнительных полей - \AmoCRM\Models\CustomFieldsValues

Пример кода, как создать коллекцию значения полей сущности:

Чтобы удалить значения поля доступен специальный объект \AmoCRM\Models\CustomFieldsValues\ValueCollections\NullCustomFieldValueCollection.

Передав этот объект, вы зануляете значение поля.

Пример:

Работа с тегами сущностей

Теги доступны как отдельный сервис tags. При создании данного сервиса, вы указываете тип сущности, с тегами которой вы будете работать.

В данный момент доступны:

1. EntityTypesInterface::LEADS,
2. EntityTypesInterface::CONTACTS,
3. EntityTypesInterface::COMPANIES,
4. EntityTypesInterface::CUSTOMERS,

Для работы с тегами конкретной сущности, нужно взаимодействовать с конкретной моделью сущности. С помощью методов getTags и setTags вы можете получить коллекцию тегов сущности или установить её.

Для изменения тегов вам необходимо передавать всю коллекцию тегов, иначе теги могут быть потеряны.

Пример добавления/изменения тегов у сущности:

или

Для удаления тегов в setTags можно передать в setTags специальный объект \AmoCRM\Collections\NullTagsCollection.

Пример удаления тегов у сущности:

Особенности работы с источниками

На данный момент источники созданные интеграциями учитываются только при создании неразобранного из чатов.

При добавлении источника обязательными полями являются external_id, name интеграция может создать в аккаунте не более 50 активных источников на аккаунт. При удалении источника, к примеру, со значением external_id: 'sales' и при повторном создании с тем же external_id crm может вернуть id раннее удаленного источника. Поэтому не стоит на стороне интеграции формировать первичный ключ из поля id.

Чтобы источник отображался в кнопке whatsapp CRM Plugin необходимо указать поле источника services с таким содержимым:

 [
   {
      "type": "whatsapp",
      "pages": [
         {
            "id": "<идентификатор или номер телефона>",
            "name": "My WhatsApp",
            "link": "<номер телефона>"
         }
      ]
   }
]

Чтобы правильно сформировать поле services можно воспользоваться моделью \AmoCRM\Collections\Sources\SourceServicesCollection

Источник по-умолчанию

Источник по-умолчанию (с полем default=true) может быть только один или отсутствовать совсем. При отсутствии источника по-умолчанию в сделках будет указан источник АПИ-интеграция с названием интеграции (как при создании неразобранного через АПИ).

Чтобы сменить источник по-умолчанию, достаточно нужному источнику проставить поле default=true, у предыдущего источника поле default будет выставлено в default=false. Но при удалении источника по-умолчанию интеграция сама должна указать новый источник по-умолчанию.

Миграция интеграции на множественные источники (для интеграций с чатами)

Источник по-умолчанию может быть использован интеграцией при переходе на множественные источники, особенно если интеграция поддерживает опцию написать первым.

К примеру исходное состояние:
Есть аккаунт с подключенной интеграцией с чатами, эта интеграция поддерживает только 1 источник. На данный момент нам не важно как была установлена интеграция: через DP или маркетплейс.

Интеграция начинает внедрение поддержки множественных источников, логически разобьем на этапы:

1 этап
Интеграция умеет работать с АПИ источниками (но не отправляет и не принимает источник в сообщениях amojo). Добавляет источник по-умолчанию, который логически соответствует источнику, использовавшемуся когда не было поддержки нескольких источников. Теперь crm будет присылать в сообщениях external_id этого источника для всех чатов которые явно не закреплены за конкретным источником.

2 этап
Интеграция умеет работать с источниками и при отправке сообщений от клиента (при создании чата) указывает external_id Все чаты с новыми сообщениями становятся размеченными по источнику.

Так же интеграция теперь обрабатывает источник и учитывает его при отправке сообщения от менеджера, в том числе при начале чата с клиентом (опция "написать первым").

3 этап
Интеграция позволяет администратору аккаунта добавить (через интеграцию) второй и последующие источники. Вся переписка числится за каким-то источником

Важный момент Источник по-умолчанию не привязывается к чатам, если его явно не передавали с сообщениями и тогда при смене источника по-умолчанию чат без разметки будет "числиться" за новым источником

Константы

Основные константы находятся в интерфейсе \AmoCRM\Helpers\EntityTypesInterface.

Также доступны константы в следующих классах/интерфейсах:

1. \AmoCRM\OAuth\AmoCRMOAuth::BUTTON_COLORS - доступные цвета для кнопки на сайт
2. \AmoCRM\Models\Unsorted\BaseUnsortedModel - константы для кодов категорий неразобранного
3. \AmoCRM\Models\CustomFields\BirthdayCustomFieldModel - константы для свойства remind у поля День Рождения
4. \AmoCRM\Models\Interfaces\CallInterface - константы статусов звонков
5. \AmoCRM\EntitiesServices\Interfaces\HasParentEntity - константы для ключей в запросах методов, у которых есть родительский сущность (в данный момент только notes)
6. \AmoCRM\Models\CustomFieldsValues\ValueModels\ItemsCustomFieldValueModel - константы для ключей значения поля Items
7. \AmoCRM\Models\Rights\RightModel - константы, связанные с правами
8. \AmoCRM\Models\AccountModel - константы для аргумента with для сервиса account
9. \AmoCRM\Models\TaskModel - константы для дефолтных типов задач
10. \AmoCRM\Models\NoteType\TargetingNote - константы поддерживаемых внешних сервисов для примечаний о таргетинге (добавляют DP)
11. \AmoCRM\Models\RoleModel - константы для аргумента with для сервиса roles
12. \AmoCRM\Models\Factories\NoteFactory - константы типов примечаний
13. \AmoCRM\Models\NoteType\MessageCashierNote - статусы примечания "Сообщение кассиру"
14. \AmoCRM\Models\LeadModel - константы для аргумента with для сервиса leads
15. \AmoCRM\Filters\Interfaces\HasOrderInterface - константы для сортировки
16. \AmoCRM\Models\EventModel - константы для аргумента with для сервиса events
17. \AmoCRM\Models\CustomFields\CustomFieldModel - константы типов полей
18. \AmoCRM\Models\Customers\CustomerModel - константы для аргумента with для сервиса customers
19. \AmoCRM\Models\ContactModel - константы для аргумента with для сервиса contacts
20. \AmoCRM\Models\CompanyModel - константы для аргумента with для сервиса companies
21. \AmoCRM\Models\CatalogElementModel - константы для аргумента with для сервиса catalogElements
22. \AmoCRM\Enum\InvoicesCustomFieldsEnums - константы для работы с полями каталога счетов
23. \AmoCRM\Enum\Chats\Templates\Buttons\ButtonsEnums - типы кнопок шаблонов чатов
24. \AmoCRM\Enum\Sources\SourceServiceTypeEnum - типы сервисов для источников

Работа в случае смены субдомена аккаунта

Одноразовые токены интеграций, расшифровка

Также вы можете распарсить и модель одноразового токена для Salesbot/Marketingbot. Для этого необходимо сделать вызов метода parseBotDisposableToken:

Примеры

В рамках данного репозитория имеется папка examples с различными примерами.

Для их работы необходимо добавить в неё файл .env со следующим содержимым, указав ваши значения:

CLIENT_ID="UUID интеграци"
CLIENT_SECRET="Секретный ключ интеграции"
CLIENT_REDIRECT_URI="https://example.com/examples/get_token.php (Важно обратить внимание, что он должен содержать в себе точно тот адрес, который был указан при создании интеграции)"

Затем вы можете поднять локальный сервер командой composer serve. После конфигурации необходимо перейти в браузере на страницу http://localhost:8181/examples/get_token.php для получения Access Token. Для получения доступа к вашему локальному серверу извне можно использовать сервис ngrok.io.

После авторизации вы можете проверить работу примеров, обращаясь к ним из браузера. Стоит отметить, что для корректной работы примеров необходимо проверить ID сущностей в них.

Работа с Issues

Если вы столкнулись с проблемой при работе с библиотекой, вы можете составить Issue, который будет рассмотрен при первой возможности.

При составлении, детально опишите проблему, приложите примеры кода, а также ответы на запросы из getLastRequestInfo.

Не забывайте удалять из примеров значимые данные, которые не должны стать достоянием общественности.

Также могут быть рассмотрены пожелания по улучшению библиотеки.

Вы можете предложить свои исправления/изменения исходного кода библиотеки, посредством создания Issue с описанием, а также Pull request с упоминанием Issue в комментарии к нему. Они будут рассмотрены и будут приняты или отклонены. Некоторые Pull Request могут остаться без ответа и действия, в случае, если правки потенциально жизнеспособны, но в данный момент не являются ключевыми для проекта.

Если вы столкнулись с проблемой функционала amoCRM - обратитесь в техническую поддержку через чат в вашем аккаунте.

License

MIT