Download the PHP package xeops/amocrm without Composer
On this page you can find all versions of the php package xeops/amocrm. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package amocrm
Клиент для работы с API amoCRM
Удобный и быстрый клиент на PHP для работы с API amoCRM, реализующий все методы оригинального API.
Внимание! Не актуальные ссылки на документацию
Данный пакет взаимодействует со старой версией API. Но это не значит, что это API более не поддерживается. Это полностью рабочее API, которое не собираются удалять, просто ссылки более не актуальные, к сожалению на данный момент единственным решением будет просмотр документации тут:
https://web.archive.org/web/20170801033744/https://developers.amocrm.ru/rest_api/
Переход на новую версию API не быстрый и займет много времени.
Установка
Через composer:
или добавить
в секцию require
файла composer.json.
Без использования composer:
Скачать последнюю версию amocrm.phar.
Быстрый старт
Список поддерживаемых моделей
- Аккаунт (документация)
- Контакт (документация)
- Сделка (документация)
- Компания (документация)
- Покупатель (документация)
- Транзакция (документация)
- Задача (документация)
- Событие (документация)
- Дополнительные поля (документация)
- Звонок (документация)
- Неразобранное (документация)
- Webhooks (документация)
- Воронки и этапы продаж (документация)
- Периоды покупателей (документация)
- Виджеты (документация)
- Каталоги (документация)
- Элементы каталогов (документация)
- Связи (документация)
Описание методов моделей
-
Модель
account
для работы с АккаунтомapiCurrent($short = false)
- Получение информации по аккаунту в котором произведена авторизацияgetUserByLogin($login = null)
- Возвращает сведения о пользователе по его логину
-
Модель
contact
для работы с КонтактамиapiList($parameters, $modified = null)
- Метод для получения списка контактов с возможностью фильтрации и постраничной выборкиapiAdd($contacts = [])
- Метод позволяет добавлять контакты по одному или пакетноapiUpdate($id, $modified = 'now')
- Метод позволяет обновлять данные по уже существующим контактамapiLinks($parameters, $modified = null)
- Метод для получения списка связей между сделками и контактами
-
Модель
lead
для работы со СделкамиapiList($parameters, $modified = null)
- Метод для получения списка сделок с возможностью фильтрации и постраничной выборкиapiAdd($leads = [])
- Метод позволяет добавлять сделки по одной или пакетноapiUpdate($id, $modified = 'now')
- Метод позволяет обновлять данные по уже существующим сделкам
-
Модель
company
для работы с КомпаниямиapiList($parameters, $modified = null)
- Метод для получения списка компаний с возможностью фильтрации и постраничной выборкиapiAdd($companies = [])
- Метод позволяет добавлять компании по одной или пакетноapiUpdate($id, $modified = 'now')
- Метод позволяет обновлять данные по уже существующим компаниям
-
Модель
customer
для работы с ПокупателямиapiList($parameters)
- Метод для получения покупателей аккаунтаapiAdd($customers = [])
- Метод позволяет добавлять покупателей по одному или пакетноapiUpdate($id)
- Метод позволяет обновлять данные по уже существующим покупателям
-
Модель
transaction
для работы с ТранзакциямиapiList($parameters)
- Метод для получения транзакций аккаунтаapiAdd($transactions = [])
- Метод позволяет добавлять транзакции по одной или пакетноapiDelete($id)
- Метод позволяет удалять транзакции
-
Модель
task
для работы с ЗадачамиapiList($parameters, $modified = null)
- Метод для получения списка задач с возможностью фильтрации и постраничной выборкиapiAdd($tasks = [])
- Метод позволяет добавлять задачи по одной или пакетноapiUpdate($id, $text, $modified = 'now')
- Метод позволяет обновлять данные по уже существующим задачам
-
Модель
note
для работы с Примечаниями (Задачами)apiList($parameters, $modified = null)
- Метод для получения списка примечаний с возможностью фильтрации и постраничной выборкиapiAdd($notes = [])
- Метод позволяет добавлять примечание по одному или пакетноapiUpdate($id, $modified = 'now')
- Метод позволяет обновлять данные по уже существующим примечаниям
-
Модель
custom_field
для работы с Дополнительными полямиapiAdd($fields = [])
- Метод позволяет добавлять дополнительные поля по одному или пакетноapiDelete($id, $origin)
- Метод позволяет удалять дополнительные поля
-
Модель
call
для работы со ЗвонкамиapiAdd($code, $key, $calls = [])
- Метод позволяет добавлять звонки по одному или пакетно
-
Модель
unsorted
для работы со Списком неразобранных заявокapiList($parameters = [])
- Метод для получения списка неразобранных заявок с возможностью фильтрации и постраничной выборкиapiGetAllSummary()
- Метод для получения агрегированной информации о неразобранных заявкахapiAccept($uids, $user_id, $status_id = null)
- Метод для принятия неразобранных заявокapiDecline($uids, $user_id)
- Метод для отклонения неразобранных заявокapiAddSip($sip = [])
- Добавление неразобранных заявок с типом SIPapiAddMail($mails = [])
- Добавление неразобранных заявок с типом MAILapiAddForms($forms = [])
- Добавление неразобранных заявок с типом FORMSaddDataLead($values)
- Добавление сделки которая будет создана после одобрения заявкиaddDataContact($values)
- Добавление контакта или компании которая будет создана после одобрения заявки
-
Модель
webhooks
для работы с WebhooksapiList()
- Метод для получения списка WebhooksapiSubscribe($url, $events = [])
- Метод для добавления WebhooksapiUnsubscribe($url, $events = [])
- Метод для удаления Webhooks
-
Модель
pipelines
для работы с Списком воронок и этапов продажapiList($id = null)
- Метод для получения списка воронок и этапов продажapiAdd($pipelines = [])
- Метод позволяет добавлять воронки и этапов продаж по одной или пакетноapiUpdate($id)
- Метод позволяет обновлять данные по уже существующим воронкам и этапам продажapiDelete($id)
- Метод позволяет удалять воронки по одной или пакетноaddStatusField($parameters, $id = null)
- Добавление этапов воронки
-
Модель
customers_periods
для работы с КомпаниямиapiList()
- Метод для получения списка периодовapiSet($periods = [])
- Метод позволяет изменять данные по периодам
-
Модель
widgets
для работы с ВиджетамиapiList($parameters = [])
- Метод для получения списка доступных для установки виджетовapiInstall($parameters)
- Метод позволяет включать виджеты по одному или пакетноapiUninstall($parameters)
- Метод позволяет выключать виджеты по одному или пакетно
-
Модель
catalog
для работы с КаталогамиapiList($id = null)
- Метод для получения списка каталогов аккаунтаapiAdd($catalogs = [])
- Метод позволяет добавлять каталоги по одному или пакетноapiUpdate($id)
- Метод позволяет обновлять данные по уже существующим каталогамapiDelete($id)
- Метод позволяет удалять данные по уже существующим каталогам
-
Модель
catalog_element
для работы с Элементами каталогаapiList($parameters = [])
- Метод для получения элементов каталога аккаунтаapiAdd($elements = [])
- Метод позволяет добавлять элементы каталога по одному или пакетноapiUpdate($id)
- Метод позволяет обновлять данные по уже существующим элементам каталогаapiDelete($id)
- Метод позволяет удалять данные по уже существующим элементам каталога
-
Модель
links
для работы со Связями между сущностямиapiList($parameters)
- Метод для получения связей между сущностями аккаунтаapiLink($links = [])
- Метод позволяет устанавливать связи между сущностямиapiUnlink($links = [])
- Метод позволяет удалять связи между сущностями
Описание работы с Webhooks
Webhooks – это уведомление сторонних приложений посредством отправки уведомлений о событиях, произошедших в amoCRM. Вы можете настроить HTTP адреса ваших приложений и связанные с ними рабочие правила в настройках своего аккаунта, в разделе «API».
Список доступных уведомлений
add_lead
- Добавить сделкуadd_contact
- Добавить контактadd_company
- Добавить компаниюadd_customer
- Добавить покупателяupdate_lead
- Изменить сделкуupdate_contact
- Изменить контактupdate_company
- Изменить компаниюupdate_customer
- Изменить покупателяdelete_lead
- Удалить сделкуdelete_contact
- Удалить контактdelete_company
- Удалить компаниюdelete_customer
- Удалить покупателяstatus_lead
- Смена статуса сделкиresponsible_lead
- Смена ответственного сделкиrestore_contact
- Восстановить контактrestore_company
- Восстановить компаниюrestore_lead
- Восстановить сделкуnote_lead
- Примечание в сделкеnote_contact
- Примечание в контактеnote_company
- Примечание в компанииnote_customer
- Примечание в покупателе
Описание хелпера Fields
Для хранения ID полей можно воспользоваться хелпером Fields
Описание хелпера B2BFamily
Хелпер для отправки письма через B2BFamily с привязкой к сделке в amoCRM
Интеграция с фреймворками
- Yii Framework 1.x (yii-amocrm)
- Yii Framework 2.x (yii2-amocrm)
- Laravel 5.x (laravel-amocrm)
Тестирование
Для начала установить --dev
зависимости. После чего запустить:
Лицензия
Библиотека доступна на условиях лицензии MIT: http://www.opensource.org/licenses/mit-license.php