<aside> 📜 СОДЕРЖАНИЕ

Передача данных из SaleBot

Рассмотрим передачу данных на примере добавления нового клиента из воронки в SaleBot.

Cбор данных клиента

Настройте сбор данных клиента в воронке, указав имена переменных, в которые соответствующие данные будут записываться.

Untitled

Настройка полей для передачи данных в соответствии с API SOHO.LMS

После того, как необходимые данные будут собраны и записаны в переменные SaleBot, в последнем блоке необходимо добавить раздел API-запрос и выбрать тип запроса POST-json.

Для передачи данных необходимо заполнить поля 1, 2, 3.

Untitled

1.URL запроса - путь к функции для выполнения запроса. Впишите адрес:

https://api.soholms.com/api/v1/client/add_client , где /api/v1/client/add_client - адрес метода используемого в запросе.

Описание методов API SOHO.LMS находятся в меню “Настройки - API”

Untitled

2. В поле "Заголовок запроса" необходимо записать заголовок в формате JSON{ "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Token " }, где Token - это авторизационный токен доступа для использования методов API в аккаунте SOHO.LMS.

Untitled

3. В поле "JSON параметры" необходимо записать сам запрос.

{
"firstName": "#{name}",
"lastName": "#{lastname}",
"phones": ["#{userphone}"]
}

где "firstName", "lastName", "phones" - параметры SOHO.LMS в которые нужно вписать данные из переменных SaleBot (#{name}, #{lastname}, #{userphone}).

Передаваемые параметры могут быть обязательными (если не передать обязательные параметры, тогда запрос вернется с ошибкой и данные не будут переданы).

Обязательные параметры выделены жирным шрифтом и в значение параметра добавлен атрибут (required).

Untitled

<aside> 💡 При создании клиента из сторонней системы посредством методов API необходимо учитывать установленные в аккаунте дополнительные поля при регистрации и создании заказа. Так же необходимо передавать данные для заполнения таких полей, поскольку без этих дополнительных сведений система не создаст нового клиента и запрос вернется с ошибкой.

</aside>

Untitled

В API SOHO.LMS используется несколько типов данных. Тип данных указан в параметрах, в последнем столбце:

Untitled

Untitled

Варианты:

  1. string – т.е. строка данные передаются в кавычках, например:

    {“firstName”: “имя”}

  2. integer – т.е. число, данные передаются без кавычек, например:

    {“clientId”: 123}

  3. Array – т.е. массив. Он содержит в себе элементы (в массиве могут быть и строки и числа), они перечисляются через запятую и находятся в квадратных скобках - []. Кол-во элементов может быть любым. Примеры:

    1. Если нужен Array[string] (массив строк):

    {“phones”: [“111111”, “222222”, “333333”]}

    1. Если нужен Array[integer] (массив чисел )

    {“addSupervisorId”: [1, 2, 3]}

  4. boolean – булевый тип, т.е. указывается «правда» или «ложь» («да» или «нет»), а именно true \ false. Например:

{“learningStatusDeep”: true}

Проверка интеграции

Для проверки корректности запроса необходимо протестировать созданную воронку. После проведенного теста, данные клиента успешно переданы в базу аккаунта SOHO.LMS.

Untitled

Запись ответов методов API

В описании каждого метода API есть информация об ответе, который возвращает этот метод в случае успешной передачи данных. Этот ответ возможно записать в качестве новой переменной клиента SaleBot в поле Сохраняемые значения.

Untitled