Пройдите простое обучение по настройке коллтрекинга.

API импорта сделок

Содержание:
   Запрос /deals
   Token авторизации
   Ответ
   Пример запроса


Запрос /deals

Общий вид запроса

где <widgetId> - идентификатор виджета.

Для авторизации запроса необходимо передать token


Тело запроса может быть в либо CSV (content type: text/csv, application/csv), либо формате JSON (content type: application/json).

Ограничения:
  • Запрос в формате CSV ограничен 1 Мb.
  • Запрос в формате JSON ограничен 50 Kb.

Если формат JSON, то сделки передаются в массиве с набором следующих полей, см. таблицу Поля сделки

Если формат CSV, то сделки передаются по одной в каждой строке с разделителем ";". Также передаётся первая строка, в которой указывается набор передаваемых полей с учётом порядка.

Таблица «Поля сделки»
Название Наличие Тип данных Описание
 
id required string Уникальный идентификатор сделки
status required string Статус сделки (список см. ниже)
timestamp required string (YYYY-MM-DDThh:mm:ss)
Дата последней модификации сделки или её статуса в формате ISO 8601
amount optional number Сумма сделки в рублях
uid optional string Идентификатор пользователя MANGO OFFICE
gaCid optional string Идентификатор пользователя Google Analytics (Client ID)
utmSource optional string Источник (метка utm_source)
utmMedium optional string Канал (метка utm_medium)
utmCampaign optional string Кампания (метка utm_campaign)
utmContent optional string Содержание (метка utm_content)
utmTerm optional string Ключевое слово (метка utm_term)
regionCode optional string ISO код региона, в котором пользователь зашёл на сайт (например MOW)
firstPath optional string Путь, по которому пользователь зашёл на сайт (например /about)
Список статусов сделок:
  • new - новая;
  • accepted - в работе;
  • closed - успешно закрытая (сделка состоялась);
  • declined - отклонённая (сделка не состоялась).

Token авторизации

Для авторизации запроса /deals необходимо передать token, полученный в личном кабинете.

Узнать идентификатор вашего виджета коллтрекинга и получить token для доступа к API вы можете в личном кабинете MANGO OFFICE, руководствуясь статьей «Подключение API».

Передавать token в ДКТ нужно одним из следующих способов:
  • в параметрах:
  • в http заголовке:


Ответ

Статусы ответов:
  • 200 OK - сделки успешно загружены;
  • 400 Bad Request - неверные параметры запроса, или ошибка в формате передаваемых данных, или слишком много данных в запросе;
  • 401 Unauthorized - не передан token авторизации;
  • 403 Forbidden - не хватает прав доступа у token'а;
  • 429 Too Many Requests - ограничение по количеству запросов.

Ответ приходит в формате application/json.
В результате успешной обработки запроса, будет выдано следующее сообщение:
В случае ошибки ответ будет такой:

Поле requestId генерится на сервере и присваивается запросу для последующего разбора инцидентов.

Список кодов ошибок:
Код ошибки Описание
 
1001 Неизвестная/неклассифицированная ошибка
1101 Неизвестный source
1102 Недопустимый размер данных
1103 Неизвестный Content-Type
1131 CSV - ошибка парсинга
1132 CSV - похоже на неверный разделитель
1133 CSV - похоже на неверный разделитель
1151 JSON - ошибка парсинга
1152 JSON - как минимум одна строка недопустимого формата
1153 JSON - как минимум одна строка недопустимого формата
1002 В разработке
1003 Внутренний запрос закончился ошибкой

Пример запроса /deals

Здесь приведен пример запроса импорта сделок, переданный от сервиса интеграций Albato к ДКТ.
Запрос:
Тело в формате application/json:
Тело в формате text/csv:
Ответ:
Ответ с ошибкой: