Цифра ↔ 1С

Список воронок

Список воронок CRM аккаунта. Расширение 1С запрашивает его при настройке, предлагает выбрать воронку с AcceptsCustomerOrder: true и указывает номер выбранной воронки в заказе клиента.

POST /api/funnels/list

Расширение 1С запрашивает список при настройке, предлагает выбрать воронку с AcceptsCustomerOrder: true и хранит выбранный номер воронки у себя.

Параметры запроса

Параметр Тип Обязательный Описание
SecretKey string Да Секретный код из настроек расширения
Логика работы
  • В список входят все воронки CRM аккаунта
  • Заказ клиента принимается только в воронку с AcceptsCustomerOrder: true, заказ в воронку с false не принимается
  • Если воронок нет — Data возвращается пустым массивом, Success остаётся true

Структура Data[]

Поле Тип Обязательный Описание
IdintegerДаНомер воронки. Его 1С указывает в заказе как FunnelId
NamestringДаНазвание воронки
TypestringДаТип воронки: production — производственная, concrete — бетонная, general — общая
AcceptsCustomerOrderbooleanДаtrue — в воронку можно отправлять заказ клиента: она производственная и в «Цифре» настроен этап, на котором создаются заказы на производство. Заказ в воронку с false не принимается
Примечания
  • Номер воронки (Id) 1С указывает в заказе клиента в поле FunnelId
  • Название воронки уникально только внутри одной CRM, поэтому в ответе указана и CRM (Crm)
  • Номер модуля (Modules[].Id) формируется так же, как Id в списке диспетчерских
Пример запроса 1С → Цифра
{
  "SecretKey": "2akgzOCYsAxLwpNl"
}
Пример ответа Цифра → 1С
{
  "Message": null,
  "Success": true,
  "Data": [
    {
      "Id": 12,
      "Name": "Изделия",
      "Type": "production",
      "Crm": { "Id": 14, "Name": "CRM" },
      "Modules": [
        { "Id": 1, "Name": "Производство Полевая", "Type": "manufacturing" },
        { "Id": 2, "Name": "Производство Шоссейная", "Type": "manufacturing" }
      ],
      "AcceptsCustomerOrder": true
    },
    {
      "Id": 7,
      "Name": "Бетон",
      "Type": "concrete",
      "Crm": { "Id": 14, "Name": "CRM" },
      "Modules": [
        { "Id": 3, "Name": "Диспетчерская Пермь", "Type": "dispatch" }
      ],
      "AcceptsCustomerOrder": false
    }
  ]
}

Коды ответов

Код Описание
200 Список получен (Success: true). Воронок нет — Data пустой массив
403 Секретный ключ не найден (Success: false)

Структура ответа

Поле Тип Описание
SuccessbooleanУспешно ли выполнен запрос
MessagestringСообщение об ошибке (null, если успешно)
DataarrayМассив воронок

Примеры ответов

{
  "Message": null,
  "Success": true,
  "Data": [
    {
      "Id": 12,
      "Name": "Изделия",
      "Type": "production",
      "Crm": { "Id": 14, "Name": "CRM" },
      "Modules": [
        { "Id": 1, "Name": "Производство Полевая", "Type": "manufacturing" }
      ],
      "AcceptsCustomerOrder": true
    }
  ]
}
{
  "Message": null,
  "Success": true,
  "Data": []
}
{
  "Message": "Секретный ключ не найден",
  "Success": false
}

См. также