Основные методы API AmoCRM

Разработчик видит AmoCRM как реляционную базу данных, доступ к которой получается через API запросы.

Авторизация

Работа с системой невозможна до того момента, как пользователь авторизуется в системе, используя логин и пароль. Использование системы с помощью API ничем не отличается в этом вопросе от пользовательского интерфейса. Методы API становятся доступными для работы только после авторизации.

URL метода - POST /private/api/auth.php

Аккаунт

Это рабочее пространство CRM-системы. С помощью запросов API можно получить информацию о сотрудниках, прикрепленных к аккаунту, оплаченной лицензии, настройках полей сделок и базе клиентов.

URL метода - GET /api/v2/account

Просмотрите фрагмент запроса:

Контакт

Это один из важнейших и основных элементов системы. Технически – это объект, состоящий из некоторого набора параметров (полей), которые ему задал администратор. Контакты могут быть прикреплены к одной или нескольким сделкам, но не могут принадлежать нескольким компаниям. Уникальными идентификаторами контактов являются такие данные как номер телефона или e-mail. В карточке контакта привязаны события, такие как новое письмо или звонок.

Добавление и обновление контакта происходит с помощью метода POST /api/v2/contacts

С помощью метода GET /api/v2/contacts/ можно вызвать список контактов с возможностью фильтровать данные в нем.

Так, например, будет выглядеть запрос на обновление контакта:

Сделка

Ещё один важный элемент в CRM-системе. Её конфигурация так же зависит от полей, установленных администратором. К сделке могут быть прикреплены контакты, а могут и отсутствовать вовсе. Элементу в обязательном порядке должен быть присвоен статус, который чаще всего совпадает с этапом воронки, где находится в данный момент сделка.

Метод позволяют добавлять сделки и обновлять данные внутри них - POST /api/v2/leads

Компания

Совпадает по своему значению с элементом «Контакт». Управлять «Компанией» можно с помощью метода - POST /api/v2/companies

Задача

Для задачи существует два необходимых параметра: дата и ответственный. При этом прикреплять задачу к сделке или контактам необязательно.

Событие

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

Вебхуки

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

1. Зайти в Настройки->Интеграции;
2. Выбрать Собственные интеграции + WebHooks;
3. Кликнуть «Добавить хук» ;
4. Ввести URL;
5. Отметить события, происходящие в системе, после которых нужно отправить уведомление;
6. Сохранить;

Amo ожидает ответа от хука в течение 2-х секунд, при 100 неудачных попытках получить ответ от сервера хук отключается, его можно подключить заново по тому же алгоритму.