Элементарный сценарий по созданию лида

Цель: Эта инструкция должна служить сторонним разработчикам интегрирующимся с "Brainysoft". Прочитав эту статью разработчик должен быть в состаянии написать код, создающий лид, создать лид, передавая только 2 значения (Имя и номер телефона) . В конце статьи находится пример кода, который также должен помочь достигнуть необходимого результата.

Этот бизнес сценарий нужно использовать тогда, когда:

• очень мало информации о потенциальном клиенте (лид)
• очень сложно заполучить информацию о потенциальном клиенте (лид)
• в системе нужно завести, хоть какую-нибудь информацию о потенциальном клиенте (лид), для дальнейшей работы с ним

Вот тогда самым идеальным и действенным способом является воспользоваться созданием лида описанным в данной статье.

Ожидаемый результат: Объект лида в системе.

В интерфейсе результат может выглядеть следующим образом:

Описание бизнес сценария в BPMN: этот сценарий отображается под цифрой 1

Сигнатура метода

Общее описание по работе с методом веб-сервиса ядра описано с статье "Нюансы при работе с API" в разделе "Метод".

POST /main/leads

Параметры пути: нет Параметры запроса: нет

Тело запроса

В теле запроса передается объект следующей структуры:

Свойство	Обязательность	Тип данных	Описание
firstName	M	string[50]	Имя. Если передать ФИО, то оно будет сохранено. В этом случае в дальнейшем возможны проблемы, если будут добавляться фамилия и отчество.
mobilePhone	M	string[50]	Номер мобильного телефона. Указываются только цифры в международном формате. Например для возможного отображения в интерфейсе как +7 (977) 620 07 77, следует передавать 797762007777.

Ошибки:

• NO_CLIENT_FIRST_NAME_ERROR - не указано имя клиента
• NO_MOBILE_PHONE_ERROR - не указан номер телефона

Пример запроса:

POST /main/leads/

{
  "firstName":"Фридрих",
  "mobilePhone":"797762007777"
}

Результат вызова метода:

Общее описание структуры возвращаемого объекта описано с статье "Нюансы при работе с API" в разделе "Метод".

Свойство	Описание
data	Идентификатор созданного лида.

Пример ответа:

{
  "status": "ok",
  "timestamp": 1550653059521,
  "data": 3692
}

Примеры кода:

$requestBody = '{
  "firstName":"Фридрих",
  "mobilePhone":"797762007719"
}';

curl_setopt_array($curl_newLead, array(
CURLOPT_PORT => "443",
CURLOPT_URL => "https://{customer}-saas.brainysoft.ru:9025/bs-core/main/leads/",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $requestBody
));

Пример кода на PHP можно посмотреть и скопировать здесь.