API
API Delta CRM — это программный интерфейс для интеграции внешних систем с CRM. Через API можно создавать, обновлять и получать данные о контактах, сделках и задачах без ручного ввода. Это позволяет связать сайт, мессенджеры, внешние сервисы и сценарии автоматизации напрямую с базой CRM.
Где найти ключи доступа
- Перейдите в рабочую область «Система» (левый верхний угол).
- В боковом меню откройте «Настройки» → «Интеграции» → «API».
Здесь доступны:
- ID аккаунта — числовой идентификатор вашего аккаунта.
- Секретный ключ — уникальный токен для авторизации.
Эти значения нужны для получения временного access_token, с которым выполняются все запросы к API.
Авторизация
Перед вызовом методов API нужно получить временный токен доступа (access_token).
Параметры запроса:
| Параметр |
Тип |
Описание |
| ACCOUNT_ID |
Число |
ID аккаунта из раздела «Интеграции → API» |
| SECRET_CODE |
Строка |
Секретный ключ из раздела «Интеграции → API» |
Ответ:
{
"access_token": "a1b2c3d4e5f6...",
"timelife": 3600
}
Особенности:
- Токен действителен 1 час (3600 секунд) с момента создания.
- После истечения срока нужно запросить новый токен.
- Все методы API принимают access_token в качестве обязательного параметра — без него запрос вернёт пустой результат.
Общий формат запросов
Все методы вызываются по схеме:
https://deltacrm.ru/api/method/{метод}?command={команда}&access_token={токен}&{параметры}
| Часть URL |
Описание |
{метод} |
Тип сущности: contact, deal, task |
command |
Действие: add, update, get |
access_token |
Временный токен авторизации |
{параметры} |
Поля сущности, передаются в теле запроса |
Все ответы возвращаются в формате JSON.
Метод: Контакт
URL: https://deltacrm.ru/api/method/contact
Поиск выполняется по одному из критериев (в порядке приоритета):
| Параметр |
Тип |
Описание |
user_id |
Число |
ID пользователя в CRM |
phone |
Строка |
Телефонный номер |
email |
Строка |
Email‑адрес |
id |
Число |
ID контакта |
Возвращаемые поля:
| Поле |
Описание |
id |
ID контакта |
name |
Имя |
last_name |
Фамилия |
phone |
Телефон |
email |
Email |
description |
Описание |
segment_id |
ID сегмента |
company_id |
ID компании |
date_create |
Дата создания |
timestamp |
Метка времени последнего изменения |
Если контакт не найден — возвращается {"error": "Контакт не найден"}.
Команда add — создать контакт
| Параметр |
Тип |
Описание |
name |
Строка |
Имя |
last_name |
Строка |
Фамилия |
email |
Строка |
Email |
phone |
Строка |
Телефон |
segment |
Массив |
Массив ID сегментов для привязки |
Возвращает ID созданного контакта.
Команда update — обновить контакт
| Параметр |
Тип |
Описание |
id |
Число (обязательно) |
ID контакта для обновления |
name |
Строка |
Новое имя |
last_name |
Строка |
Новая фамилия |
email |
Строка |
Новый email |
phone |
Строка |
Новый телефон |
segment |
Массив |
Массив ID сегментов |
Передаются только поля, которые нужно обновить. Возвращает ID контакта при успехе.
Метод: Сделка
URL: https://deltacrm.ru/api/method/deal
Команда get — получить сделку
| Параметр |
Тип |
Описание |
id |
Число |
ID сделки |
Возвращаемые поля:
| Поле |
Описание |
id |
ID сделки |
funnel_id |
ID воронки продаж |
name |
Название сделки |
status |
Статус сделки (ID статуса в воронке) |
description |
Описание |
contact_id |
ID связанного контакта |
company_id |
ID связанной компании |
object_id |
ID связанного объекта недвижимости |
user_id |
ID ответственного сотрудника |
sum |
Сумма сделки |
date_create |
Дата создания |
timestamp |
Метка времени последнего изменения |
Если сделка не найдена — возвращается {"error": "Сделка не найдена"}.
Команда add — создать сделку
| Параметр |
Тип |
Описание |
funnel_id |
Число |
ID воронки продаж |
name |
Строка |
Название сделки |
status |
Число/строка |
ID статуса в воронке |
description |
Строка |
Описание сделки |
contact_id |
Число |
ID контакта |
company_id |
Число |
ID компании |
object_id |
Число |
ID объекта недвижимости |
user_id |
Число |
ID ответственного сотрудника |
sum |
Число |
Сумма сделки |
Возвращает ID созданной сделки.
Команда update — обновить сделку
| Параметр |
Тип |
Описание |
id |
Число (обязательно) |
ID сделки для обновления |
funnel_id |
Число |
Новый ID воронки |
name |
Строка |
Новое название |
status |
Число/строка |
Новый статус |
description |
Строка |
Новое описание |
contact_id |
Число |
Новый ID контакта |
company_id |
Число |
Новый ID компании |
object_id |
Число |
Новый ID объекта |
user_id |
Число |
Новый ответственный |
sum |
Число |
Новая сумма |
Передаются только поля, которые нужно обновить. Возвращает ID сделки при успехе.
Метод: Задача
URL: https://deltacrm.ru/api/method/task
Команда get — получить задачу
| Параметр |
Тип |
Описание |
id |
Число |
ID задачи |
Возвращаемые поля:
| Поле |
Описание |
id |
ID задачи |
name |
Название задачи |
description |
Описание |
contact_id |
ID связанного контакта |
company_id |
ID связанной компании |
deal_id |
ID связанной сделки |
object_id |
ID связанного объекта |
object_type |
Тип объекта |
user_id |
ID ответственного сотрудника |
complete |
Статус выполнения (Y/N) |
date |
Срок выполнения |
date_activity_start |
Дата начала активности |
date_create |
Дата создания |
timestamp |
Метка времени последнего изменения |
Если задача не найдена — возвращается {"error": "Сделка не найдена"} (текст ошибки будет исправлен в следующих версиях).
Команда add — создать задачу
| Параметр |
Тип |
Описание |
name |
Строка |
Название задачи |
description |
Строка |
Описание |
contact_id |
Число |
ID контакта |
company_id |
Число |
ID компании |
deal_id |
Число |
ID сделки |
object_id |
Число |
ID объекта |
object_type |
Строка |
Тип объекта |
user_id |
Число |
ID ответственного сотрудника |
complete |
Строка |
Статус выполнения (Y/N) |
date |
Строка (дата) |
Срок выполнения |
date_activity_start |
Строка (дата) |
Дата начала активности |
date_create |
Строка (дата) |
Дата создания |
timestamp |
Строка |
Метка времени |
Возвращает ID созданной задачи.
Команда update — обновить задачу
| Параметр |
Тип |
Описание |
id |
Число (обязательно) |
ID задачи для обновления |
name |
Строка |
Новое название |
description |
Строка |
Новое описание |
contact_id |
Число |
Новый ID контакта |
company_id |
Число |
Новый ID компании |
deal_id |
Число |
Новый ID сделки |
object_id |
Число |
Новый ID объекта |
object_type |
Строка |
Новый тип объекта |
user_id |
Число |
Новый ответственный |
complete |
Строка |
Новый статус выполнения (Y/N) |
date |
Строка (дата) |
Новый срок |
date_activity_start |
Строка (дата) |
Новая дата начала |
Передаются только поля, которые нужно обновить. Возвращает ID задачи при успехе.
Примеры запросов
Создание контакта
POST https://deltacrm.ru/api/method/contact
?command=add
&access_token=a1b2c3d4e5f6...
&name=Иван
&last_name=Петров
&phone=79991234567
&email=ivan@example.com
Ответ:
12345
(где 12345 — ID созданного контакта)
Получение сделки по ID
GET https://deltacrm.ru/api/method/deal
?command=get
&access_token=a1b2c3d4e5f6...
&id=77
Ответ:
{
"id": "77",
"funnel_id": "1",
"name": "Продажа квартиры на Ленина 10",
"status": "3",
"description": "",
"contact_id": "12345",
"company_id": "0",
"object_id": "88",
"user_id": "5",
"sum": "5000000",
"date_create": "2025-03-15 12:30:00",
"timestamp": "2025-09-18 10:00:00"
}
Создание задачи для сделки
POST https://deltacrm.ru/api/method/task
?command=add
&access_token=a1b2c3d4e5f6...
&name=Позвонить клиенту
&deal_id=77
&user_id=5
&date=2026-09-20
Ответ:
901
Важные нюансы
- Токен недолговечен: срок жизни — 1 час. Если токен истёк, методы вернут пустой результат (не ошибку, а отсутствие данных). Перед каждым пакетом запросов проверяйте актуальность токена.
- Передавайте только нужные поля: в методах add и update необязательные поля можно опустить — система сохранит или оставит без изменения те, что не переданы.
- Метод list (списки): в коде методов присутствует команда list, но она пока закомментирована — получение списков сущностей через API пока не доступно.
- Безопасность: не публикуйте access_token, ACCOUNT_ID и SECRET_CODE в открытом доступе (фронтенд, публичные репозитории). Все запросы с этими значениями должны выполняться на стороне сервера.
- Формат дат: система ожидает даты в формате YYYY-MM-DD или YYYY-MM-DD HH:MM:SS.
