<aside>
⚠️ ВНИМАНИЕ!
Для формирования заявок с сайта используется отдельное, упрощенное API, все его свойства описаны только на этой странице.
</aside>
<aside>
⚠️ Применяется для систем: XLombard, XProkat
</aside>
<aside> 💡 Где посмотреть данные для интеграции в программах XLombard или XProkat см. в отдельной статье Где найти ключи подключения
</aside>
<aside> 💡 Также можно выгрузить все необходимые данные в одном файле Выгрузка формы “Пример запроса API”
</aside>
Для отправки заявки в XLombard необходимо методом GET или POST вызвать следующий url (кодировка запроса UTF8):
**<адрес сервера>**/handlers/requests.ashx?operation=add&token=**<токен доступа>**&input=**{jsondata}**
ВАЖНО! объект {jsondata} можно записать непосредственно в тело запроса, но способ передачи данных при этом обязательно POST, при этом параметры operation=add&token=<токен доступа> остаются в URL вызываемого обработчика
где:
{jsondata}: объект в формате json (описание см. ниже), содержащий поля заявки
<адрес сервера>: адрес сервера XLombard
<токен доступа>: ключ доступа по API
{
"FilialId": "код филиала",
"FilialCity": "город филиала",
"AdditionalFilials": [],
"DealTypeId":"код услуги",
"Source":"источник заявки",
"SourceDetails": "детализация источника",
"PartnerCode":"код партнера",
"ClientPhone":"телефон клиента",
"ClientMail":"Email клиента",
"TelegramAccount":"аккаунт Telegram",
"ClientName":"имя клиента",
"ClientComment":"комментарий клиента",
"Utm_source":"",
"Utm_campaign":"",
"Utm_medium":"",
"Utm_term":"",
"Utm_content":"",
"Utm_position_type": "",
"Utm_device_type" : "",
"Utm_region_name" : "",ё
"SessionId":"",
"City": "",
"CityTimeZone": -100,
"AdvertClientId_1":"код клиента системы аналитики (например, яндрекс.метрика или google.analytics",
"AdvertClientId_2":"код клиента системы аналитики (например, яндрекс.метрика или google.analytics",
"RefUrl":"адрес, с которого пришел клиент на страницу оформления заявки",
"ExternalImages":[],
"Fields": [
{
"Key":"client-summ",
"Value":"50000"
},
{
"Key":"auto-marka-model",
"Value":"Митсубиси асх"
},
{
"Key":"auto-year",
"Value":"2009"
} ]
}
где:
| Ключ | Тип | Описание |
|---|---|---|
| FilialId | число | код филиала в который должна поступить заявка |
| FilialCity | строка | если при пацередаче код филиала определить не получается, можно передать название города, в котором располагается филиал. В этом случае код филиала (FilialId) должен быть ОБЯЗАТЕЛЬНО передан со значением -1. |
| AdditionalFilials | массив чисел | массив кодов филиалов (чисел), сотрудники которых тоже должны иметь доступ к данной заявке |
| DealTypeId | число | код услуги (числовой код смотрим в конфигураторе для каждого типа услуги на вкладке Базовые справочники) |
| Source | строка | источник заявки (например адрес сайта без http) |
| SessionId | строка | код сессии клиента, в рамках которой была создана текущая заявка. Также может быть проинициализировано кодом заявки во внешней системе - например, у лидогенератора |
| PartnerCode | число в строковом представлении | код партнера |
| ClientComment | строка | значение добавляется в ленту событий, недоступно для изменения сотрудниками |
| ExternalImages | массив строк | массив ссылок для скачивания изображений, которые необходимо прикрепить к заявке, изображение обязательно должно быть доступно методом Get по http или https. Элементом массива является строка, содержащая полный URL для скачивания изображения |
| Fields | объект | набор полей (приведены для примера), соответствующих выбранному DealTypeid |
| City | строка | город клиента, если переданный город более 400 тыс. населения, то будет автоматически добавлен регион и область принадлежности, а также значение TimeZone |
| CityTimeZone | число | используется для передачи TimeZone города клиента, будет применено ТОЛЬКО в случае если город не будет распознан автоматически |
<aside>
☝🏻 Коллекция Fields представляет собой массив объектов следующего формата: Fields:[{"key":<строка>, "value":{<объект>}}], где key:всегда строка (используется для идентификации полей в объекте заявки, value: объект, содержащий необходимый набор значений для инициализации поля в заявке.
</aside>
<aside> 💡
ОЧЕНЬ ОЧЕНЬ ВАЖНО! В документации набор полей в коллекции Fields приведен ТОЛЬКО для примера отображения структуры данных. Использовать их нельзя, так как у каждого клиента свой набор полей и их типов.
</aside>