Документация для версии WT AmoCRM v.1.2.1

Системные требования

Joomla 4.2.7+, Joomla 5. PHP 7.4+.

Для работы с Joomla 6 рекомендуется версия библиотеки 1.3+

Подключение библиотеки в своё расширение для Joomla

use Webtolk\Amocrm\Amocrm;

$amocrm = new Amocrm();
$result_amo_crm = $amocrm->getAccountInfo();

Список методов библиотеки

getAccountInfo

Метод getAccountInfo библиотеки WT AmoCRM для Joomla возвращает информацию об аккаунте AmoCRM. В Joomla расширениях нужен, скорее, для индикации нормальной связи с AmoCRM.

Реализуемый метод API: GET /api/v4/account.

getLeadById

Метод для получения данных конкретной сделки Amo CRM по её id. В ответе приходят пользовательские поля сделки, контакты, компании, id воронки и т.д.

Реализуемый метод API: GET /api/v4/leads/{id}.

createLeads

Метод позволяет добавлять сделки из Joomla в аккаунт AmoCRM пакетно.

Реализуемый метод API: POST /api/v4/leads.

createLeadsComplex

Комплексное добавление сделок с контактом и компанией. Метод позволяет добавлять сделки c контактом и компанией в аккаунт пакетно. Добавляемые данные могут быть проверены в контроле дублей.

Реализуемый метод API: POST /api/v4/leads/complex.

getTags

Получение списка тегов для сущности AmoCRM. 

Реализуемый метод API: GET /api/v4/{entity_type:leads|contacts|companies|customers}/tags.

getLeadsPiplines

Метод для получения списка воронок продаж для сделок.

Реализуемый метод API: GET /api/v4/leads/pipelines.

getLeadsCustomFields

Метод для получения списка полей для сделок AmoCRM. 

Реализуемый метод API: GET /api/v4/leads/custom_fields.

getContactsCustomFields

Метод для получения списка полей для контактов AmoCRM. 

Реализуемый метод API: GET /api/v4/сontacts/custom_fields.

getCompaniesCustomFields

Метод для получения списка полей для компаний AmoCRM. 

Реализуемый метод API: GET /api/v4/companies/custom_fields.

getCustomersCustomFields

Метод для получения списка полей для покупателей AmoCRM. 

Реализуемый метод API: GET /api/v4/сustomers/custom_fields.

getContacts

Метод для получения списка контактов AmoCRM. 

Реализуемый метод API: GET /api/v4/contacts.

getUserById

Получение пользователя AmoCRM по его id.

Реализуемый метод API: GET /api/v4/users/{id}.

getNotes

Список примечаний по конкретной сущности, по ID сущности.

Реализуемый метод API: GET /api/v4/{entity_type}/{entity_id}/notes.

addNotes

Добавление примечаний к сущности.

Реализуемый метод API: POST /api/v4/{entity_type}/notes.

Реализуемый метод API: POST /api/v4/{entity_type}/{entity_id}/notes.

Поля Amo CRM для Joomla Form

Библиотека содержит набор Joomla Form полей с информацией, получаемой из Amo CRM.

Accountinfo

Выводит html с данными об аккаунте Amo CRM. Пример использования в XML-манифестах модулей и плагинов Joomla 4.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="accountinfo" name="accountinfo"/>

Companiestagslist - Companies tags list 

Список тегов для компаний в Amo CRM.  Пример использования в XML-манифестах модулей и плагинов Joomla 4.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="сompaniestagslist" name="company_tag_id"/>

Contactstagslist - Contacts tags list

Список тегов для контактов в Amo CRM.  Пример использования в XML-манифестах модулей и плагинов Joomla 4.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="contactstagslist" name="contact_tag_id"/>

Leadcustomfieldslist - Lead custom fields list

Список настраиваемых полей Amo CRM для сделок.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadcustomfieldslist" name="lead_custom_field_id"/>

Leadspipelineslist - Leads pipelines list

Список воронок продаж Amo CRM.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadspipelineslist" name="pipeline_id"/>

Leadstagslist - Leads tags list

Список тегов для сделок

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadstagslist" name="lead_tag_id"/>