⚡ REST API v2

API Electrum CRM

Базовый URL: http://localhost:8080/api/v2 · Формат: JSON · Кодировка: UTF-8

Введение

REST API Electrum CRM позволяет интегрировать CRM с любыми внешними системами: сайтами, ERP, телефонией, чат-ботами и собственными приложениями. API доступен для тарифных планов «Про» и «Корпоративный».

Все запросы выполняются по протоколу HTTP/HTTPS. Тело запросов и ответов — JSON. Доступны SDK для Python, Node.js и PHP.

Аутентификация

API использует Bearer-токены. Получите токен в разделе Настройки → API → Создать токен. Передавайте токен в заголовке каждого запроса:

Authorization: Bearer ваш_api_токен # Пример с curl curl -X GET http://localhost:8080/api/v2/contacts \ -H "Authorization: Bearer ваш_api_токен" \ -H "Content-Type: application/json"

Безопасность: Храните токены в переменных окружения, не публикуйте их в коде. Токен можно отозвать в любой момент из панели настроек.

Коды ошибок

API возвращает стандартные HTTP-коды состояния:

200 OK — запрос выполнен успешно
201 Created — ресурс создан
400 Bad Request — ошибка в параметрах запроса
401 Unauthorized — неверный или отсутствующий токен
403 Forbidden — недостаточно прав
404 Not Found — ресурс не найден
429 Too Many Requests — превышен лимит запросов (100/мин)
500 Internal Server Error — ошибка сервера

{ "error": "not_found", "message": "Контакт с ID 123 не найден", "status": 404 }

Пагинация

Список-запросы возвращают до 100 записей. Для постраничной навигации используйте параметры page и per_page:

GET /api/v2/contacts?page=2&per_page=50 # Ответ содержит мета-информацию: { "data": [...], "meta": { "page": 2, "per_page": 50, "total": 1284, "total_pages": 26 } }

Контакты

GET /api/v2/contacts Получить список контактов

GET /api/v2/contacts/{id} Получить контакт по ID

POST /api/v2/contacts Создать новый контакт

PUT /api/v2/contacts/{id} Обновить контакт

DELETE /api/v2/contacts/{id} Удалить контакт

Пример: создать контакт

POST /api/v2/contacts { "name": "Иван Петров", "phone": "+79991234567", "email": "ivan@company.ru", "company": "ООО Рога и Копыта", "tags": ["Новый", "Тёплый"] } # Ответ 201 Created: { "id": 4821, "name": "Иван Петров", "created_at": "2026-03-20T10:15:00Z" }

Сделки

GET/api/v2/dealsСписок сделок (фильтры: pipeline_id, stage, assigned_to)

POST/api/v2/dealsСоздать сделку

PUT/api/v2/deals/{id}Обновить сделку (перенести на этап, изменить сумму)

DELETE/api/v2/deals/{id}Удалить сделку

Задачи

GET/api/v2/tasksСписок задач

POST/api/v2/tasksСоздать задачу

PUT/api/v2/tasks/{id}/completeОтметить задачу выполненной

Пользователи

GET/api/v2/usersСписок пользователей

GET/api/v2/users/meТекущий пользователь

Воронки

GET/api/v2/pipelinesСписок воронок со стадиями

Вебхуки

Вебхуки позволяют получать события в режиме реального времени. Настройте URL для получения уведомлений в разделе Настройки → API → Вебхуки.

Доступные события

contact.created — создан новый контакт
contact.updated — контакт изменён
deal.created — создана сделка
deal.stage_changed — сделка перешла на новый этап
deal.won — сделка закрыта успешно
deal.lost — сделка проиграна
task.completed — задача выполнена

# Пример входящего вебхука: POST https://your-server.com/crm-webhook { "event": "deal.won", "timestamp": "2026-03-20T14:32:00Z", "data": { "deal_id": 1092, "amount": 250000, "contact_id": 4821 } }