Внешний API XCRM

API нужен для интеграций с сайтами клиентов, внешними формами, каталогами и BI-выгрузками. Модель доступа похожа на CRM-интеграции: компания создаёт API ключ, внешний сервис вызывает методы от имени этой компании.

Доступ и тарифы

Премиум и VIP: read-only API для выгрузки клиентов, автомобилей, заказов, услуг и товаров.

Премиум и выше: создание заявок с сайта в воронке заказ-нарядов.

API ключ создаётся в разделе Настройки > Интеграции > API доступ XCRM. Полный ключ показывается только один раз.

Авторизация

Передавайте API ключ одним из способов:

X-XCRM-API-Key: xcrm_ваш_ключ

Authorization: ApiKey xcrm_ваш_ключ

Методы

Метод	Endpoint	Тариф	Назначение
GET	/clients	Премиум+	Выгрузка клиентов. Поддерживает search, limit, offset.
GET	/vehicles	Премиум+	Выгрузка автомобилей. Поддерживает clientId, limit, offset.
GET	/orders	Премиум+	Выгрузка заказ-нарядов. Поддерживает status, updatedFrom, limit, offset.
GET	/services	Премиум+	Выгрузка каталога услуг. Поддерживает search, limit, offset.
GET	/products	Премиум+	Выгрузка товаров и остатков. Поддерживает search, limit, offset.
POST	/site-leads	Премиум+	Создание лида из формы сайта в воронке заказ-нарядов со статусом «Заявка с сайта».

Пример: заявка с сайта

curl -X POST "https://api.xcrm.pro/public-api/v1/site-leads" \
  -H "Content-Type: application/json" \
  -H "X-XCRM-API-Key: xcrm_ваш_ключ" \
  -d '{
    "title": "Запись на диагностику",
    "source": "site",
    "pageUrl": "https://service.ru/diagnostics",
    "client": {
      "name": "Иван Петров",
      "phone": "+79990000000",
      "email": "ivan@example.ru"
    },
    "vehicle": {
      "brand": "Toyota",
      "model": "Camry",
      "licensePlate": "А123ВС777",
      "mileage": 120000
    },
    "comment": "Нужна диагностика подвески"
  }'

XCRM создаст или найдёт клиента и автомобиль, создаст заказ-наряд, поставит статус «Заявка с сайта» и отправит уведомление администраторам и менеджерам.

Пример: выгрузка заказов

curl "https://api.xcrm.pro/public-api/v1/orders?updatedFrom=2026-04-01T00:00:00.000Z&limit=50" \
  -H "X-XCRM-API-Key: xcrm_ваш_ключ"

Как организовывать интеграцию

Для сайта: форма отправляет данные в /site-leads, менеджер обрабатывает лид в воронке.

Для внешней CRM/BI: сервис периодически читает /orders, /clients, /products с фильтрами limit/offset/updatedFrom.

Для безопасности: один API ключ на один внешний сервис, ключ удаляется при отключении интеграции.