API CRM Инклиент - функции и инструменты для разработки

API CRM Инклиент

Руководство по работе с функциями API-функциями CRM Инклиент

Как начать

Шаг 1. Установите срм систему на хостинг

Шаг 2. В файле local.php по пути [папка срм]\protected\config\ установите ключ для обращения к API: ‘ApiKey’ => ‘password’,

Шаг 3. Сформируйте API-запросы.
),
    'params' => [
        'ApiKey' => 'password', ]);

Создание клиента

Создание клиента.

URL

/api/page/CreateLead

Входящие параметры

Поля из запроса /api/page/GetAdditionalFields

Пример вызова функции

$data = [
'fieldFio' => 'Иван',
'email_1' => 'test@test.ru',
'phone_1' => '1234',
'field_4' => 'тест',
'field_12' => '2012-01-01 11:11:11',
'field_11' => 'test',
];
ksort($data);
$sign = md5(implode('', $data) . $apiKey);
$data['sign'] = $sign;
$ch = curl_init();
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_URL, $apiDomain . '/api/page/CreateLead');
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$html = curl_exec($ch);
curl_close($ch);
$resultClient = json_decode($html, true);

Получение дополнительных полей

Получение дополнительных полей из анкеты контакта.

URL

/api/page/GetAdditionalFields

Типы полей

  • Текст – разрешены любые символы
  • Число – только число и спецсимволы (+ ( ) / и т.д.)
  • Селектор – разрешены любые символы
  • Чебокс – On или Off
  • Дата – разрешенный формат даты 31.12.2000 10:00.

Пример в базе данных: field_17, field_32, fieldDescription, fieldAddInfo.

Поля можно удалить из срм системы.

Уникальные поля

  • fieldFio – имя клиента
  • fieldTelephone – телефон клиента
  • fieldEmail – емейл клиента.

Уникальные поля невозможно удалить из срм. 

Пример вызова функции

$data = []; $sign = md5(implode('', $data) . $apiKey);

$data['sign'] = $sign;

$ch = curl_init();

curl_setopt($ch, CURLOPT_POST, 0);

curl_setopt($ch, CURLOPT_URL, $apiDomain . '/api/page/GetAdditionalFields?' . http_build_query($data));

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$html = curl_exec($ch);

curl_close($ch);

$resultClient = json_decode($html, true);

Отправка почты

Отправка почтовых уведомлений.

Предварительно настройте почту в local.php.

URL

/api/page/SendEmail

Входящие параметры

  • email – email куда отправить письмо
  • subject – тема письма
  • text – текст письма.

Пример вызова функции

$data = [

'email' => test@test.ru,

'subject' => 'Тема',

'text' => 'Сообщение',

];

ksort($data);

$sign = md5(implode('', $data) . $apiKey);

$data['sign'] = $sign;

$ch = curl_init();

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_URL, $apiDomain . '/api/page/SendEmail');

curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

curl_setopt($ch, CURLOPT_RETURNTRANSFER, false);

$html = curl_exec($ch);

curl_close($ch);

$resultClient = json_decode($html, true);