Данная статья представляет собой обзор работы с REST API amoCRM версии 4, предназначенного для интеграции внешних систем с CRM․ API позволяет автоматизировать процессы управления контактами, компаниями и сделками, значительно повышая эффективность бизнес-операций․ Все запросы к API осуществляются по адресу /api/v4/․ Важно отметить, что код авторизации (OAuth-токен) может быть использован только один раз для получения токена доступа․ Для упрощения процесса авторизации рекомендуется использовать встроенный OAuth-сервер․
Авторизация в API
Для доступа к API необходимо пройти процедуру авторизации․ В amoCRM используется OAuth 2․0․ User Hash (ключ для авторизации) можно найти в настройках пользователя в amoCRM (страница “Пользователи аккаунта”)․ После получения токена доступа, его необходимо хранить и использовать в последующих запросах в заголовке Authorization․
Работа с контактами
Получение списка контактов
Для получения списка контактов необходимо выполнить GET-запрос к эндпоинту /api/v4/contacts․ Можно использовать параметры фильтрации и пагинации для управления объемом возвращаемых данных․
Создание контакта
Для создания нового контакта необходимо выполнить POST-запрос к эндпоинту /api/v4/contacts․ В теле запроса необходимо передать JSON-объект с данными контакта․
Редактирование контакта
Для редактирования существующего контакта необходимо выполнить PATCH-запрос к эндпоинту /api/v4/contacts/{contact_id}, где {contact_id} – идентификатор контакта․
Удаление контакта
Для удаления контакта необходимо выполнить DELETE-запрос к эндпоинту /api/v4/contacts/{contact_id}․
Работа с компаниями
Получение списка компаний
Для получения списка компаний необходимо выполнить GET-запрос к эндпоинту /api/v4/companies․ Поддерживаются параметры фильтрации и пагинации․
Создание компании
Для создания новой компании необходимо выполнить POST-запрос к эндпоинту /api/v4/companies․ В теле запроса передается JSON-объект с данными компании․
Редактирование компании
Для редактирования компании необходимо выполнить PATCH-запрос к эндпоинту /api/v4/companies/{company_id}․
Удаление компании
Для удаления компании необходимо выполнить DELETE-запрос к эндпоинту /api/v4/companies/{company_id}․
Работа со сделками
Получение списка сделок
Для получения списка сделок необходимо выполнить GET-запрос к эндпоинту /api/v4/leads․ Доступны параметры фильтрации по воронкам, статусам и другим критериям․
Создание сделки
Для создания новой сделки необходимо выполнить POST-запрос к эндпоинту /api/v4/leads․ В теле запроса передается JSON-объект с данными сделки․
Редактирование сделки
Для редактирования сделки необходимо выполнить PATCH-запрос к эндпоинту /api/v4/leads/{lead_id}․
Удаление сделки
Для удаления сделки необходимо выполнить DELETE-запрос к эндпоинту /api/v4/leads/{lead_id}․
Работа со связями
API amoCRM позволяет устанавливать связи между контактами, компаниями и сделками․ Это позволяет создавать комплексные представления о клиентах и их взаимодействии с бизнесом․
- Получение связей: Используйте соответствующие эндпоинты для получения связей между сущностями․
- Привязка: Для привязки сущностей используйте методы создания связей․
- Отвязка: Для отвязки сущностей используйте методы удаления связей․
Дополнительные возможности
Помимо работы с основными сущностями, API amoCRM предоставляет возможности для работы с:
- Воронками продаж: Получение, создание, изменение и удаление воронок․
- Списками: Получение, создание и редактирование списков․
- Файлами: Загрузка, удаление и получение информации о файлах․
API amoCRM предоставляет мощный инструмент для интеграции CRM-системы с другими приложениями и сервисами․ Используя API, можно автоматизировать бизнес-процессы, повысить эффективность работы и улучшить качество обслуживания клиентов․ Подробную документацию по API можно найти на официальном сайте amoCRM․
