Документация по API

Для подключения вашего сайта к платформе API Delta CRM выполните следующие действия:
1. Создайте новое, или возьмите уже готовое приложение в разделе
«Управление» -> «Приложения»
2. Укажите домен подключаемого сайта.
3. Возьмите id и защищенный ключ приложения. Они будут использоваться при инициализации платформы API.

Инициализация платформы API

POST /api/access_token.php
Параметры:
Параметр Тип Описание
app_id Строка ID приложения
app_secret Строка Секретный код
Пример:
<?php 
$secret_code 
"ovmKVF5HjiRC4FJAq2Rbf5PiWR8iOS";
$URL "http://deltacrm.ru/api/access_token.php";
$arPost = array("app_id"=>1"app_secret"=>$secret_code);    
$out PostRequest($URL$arPost);
$arRes json_decode($out,true);
$access_token $arRes["access_token"];
?>
Результат:
Возвращает токен авторизации и время жизни сессии. Токен авторизации и секретный ключ указываются во всех последующих методах.
Параметр Тип Описание
access_token Строка Токен авторизации
timelife Строка Время жизни токена в секундах

Получение списка сделок

POST /api/get_deal.php
Параметры:
Параметр Тип Описание
filter Массив Массив значений для фильтрации
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arPost 
= array(
    
"filter"=>array("ID"=>array(12)), 
    
"access_token"=>$access_token
    
"secret_code"=>$secret_code
);
$URL="http://deltacrm.ru/api/get_deal.php";
$out PostRequest($URL$arPost);
$arRes=json_decode($out,true);
?>
Результат:
Возвращает отфильтрованный список сделок.
Допустимые параметры фильтра:
Параметр Тип Описание
ID Массив Коды сделок
CONTACT_ID Число Код контакта
NAME Строка Наименование сделки
DATE_START_FROM Дата (Y-m-d) Дата открытия сделки - начало периода
DATE_START_TO Дата (Y-m-d) Дата открытия сделки - окончание периода
DATE_CLOSE_FROM Дата (Y-m-d) Дата закрытия сделки - начало периода
DATE_CLOSE_TO Дата (Y-m-d) Дата закрытия сделки - окончание периода
STATUS Число Код статуса сделки

Добавление сделки

POST /api/add_deal.php
Параметры:
Параметр Тип Описание
fields Массив Массив параметров сделки
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arFields 
= array(
    
"NAME"=>"Новая сделка",
    
"CONTACT_ID"=>1,
    
"USER_ID"=>1,
    
"SUM"=>1000000,
);
$arPost = array("fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/add_deal.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Результат:
Возвращает код созданной сделки
Допустимые параметры сделки:
Параметр Тип Описание
NAME Строка Наименование сделки
SUM Число Сумма сделки
DESCRIPTION Текст Описание
DATE_START Дата (Y-m-d) Дата начала
DATE_CLOSE Дата (Y-m-d) Дата окончания
CONTACT_ID Число Код контакта
USER_ID Число Код сотрудника
PROP_{код свойства} Определяется типом свойства Пользовательское свойство

Изменение сделки

POST /api/update_deal.php
Параметры:
Параметр Тип Описание
deal_id Число Код сделки
fields Массив Массив параметров сделки
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arFields 
= array(
    
"NAME"=>"Новое наименование сделки",
    
"SUM"=>1000000,
);
$arPost = array("deal_id"=>1"fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/update_deal.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Допустимые параметры сделки:
Параметр Тип Описание
NAME Строка Код сделки
DESCRIPTION Текст Описание
DATE_START Дата (Y-m-d) Дата начала
DATE_CLOSE Дата (Y-m-d) Дата окончания
CONTACT_ID Число Код контакта
USER_ID Число Код сотрудника
PROP_{код свойства} Определяется типом свойства Пользовательское свойство

Получение списка контактов

POST /api/get_contact.php
Параметры:
Параметр Тип Описание
filter Массив Массив значений для фильтрации
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arPost 
= array(
    
"filter"=>array("ID"=>array(12)), 
    
"access_token"=>$access_token
    
"secret_code"=>$secret_code
);
$URL="http://deltacrm.ru/api/get_contact.php";
$out PostRequest($URL$arPost);
$arRes=json_decode($out,true);
?>
Результат:
Возвращает отфильтрованный список контактов.
Допустимые параметры фильтра:
Параметр Тип Описание
ID Массив Код контакта
NAME Строка Имя
LAST_NAME Строка Фамилия
SECOND_NAME Строка Отчество
EMAIL Строка Email
PHONE Строка Телефон
COMPANY_ID Число Код компании

Добавление контакта

POST /api/add_contact.php
Параметры:
Параметр Тип Описание
fields Массив Массив параметров контакта
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arFields 
= array(
    
"NAME"=>"Новый контакт",
    
"USER_ID"=>1,
    
"PHONE"=>"+10001110011",
    
"EMAIL"=>"support@deltacrm.ru",
);
$arPost = array("fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/add_contact.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Результат:
Возвращает код созданного контакта
Допустимые параметры контакта:
Параметр Тип Описание
NAME Строка Имя
LAST_NAME Строка Фамилия
SECOND_NAME Строка Отчество
EMAIL Email Email
COMPANY_ID Число Код компании
USER_ID Число Код сотрудника
PHONE Строка Телефон
PROP_{код свойства} Определяется типом свойства Пользовательское свойство

Изменение контакта

POST /api/update_contact.php
Параметры:
Параметр Тип Описание
CONTACT_ID Число Код контакта
FIELDS Массив Массив параметров контакта
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arFields 
= array(
    
"NAME"=>"Новое имя",
    
"PHONE"=>"+10001110011",
);
$arPost = array("contact_id"=>1"fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/update_contact.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Допустимые параметры контакта:
Параметр Тип Описание
NAME Строка Имя
LAST_NAME Строка Фамилия
SECOND_NAME Строка Отчество
EMAIL Email Email
COMPANY_ID Число Код компании
USER_ID Число Код сотрудника
PHONE Строка Телефон
PROP_{код свойства} Определяется типом свойства Пользовательское свойство

Получение списка задач

POST /api/get_activity.php
Параметры:
Параметр Тип Описание
filter Массив Массив значений для фильтрации
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arPost 
= array(
    
"filter"=>array("ID"=>array(12)), 
    
"access_token"=>$access_token
    
"secret_code"=>$secret_code
);
$URL="http://deltacrm.ru/api/get_activity.php";
$out PostRequest($URL$arPost);
$arRes=json_decode($out,true);
?>
Результат:
Возвращает отфильтрованный список задач.
Допустимые параметры фильтра:
Параметр Тип Описание
ID Число Код задачи
NAME Строка Наименование задачи
STATUS N, Y, F Статус задачи - N-выполняется, Y-успешно завершено, F-не выполнено.
DATE_START_FROM Дата (Y-m-d H:i:s) Дата начала выполнения - начало периода
DATE_START_TO Дата (Y-m-d H:i:s) Дата начала выполнения - окончание периода
DEADLINE_FROM Дата (Y-m-d H:i:s) Дэдлайн - начало периода
DEADLINE_TO Дата (Y-m-d H:i:s) Дэдлайн - окончание периода
USER_ID Число Код сотрудника
DEAL_ID Число Код сделки
CONTACT_ID Число Код контакта

Добавление задачи

POST /api/add_activity.php
Параметры:
Параметр Тип Описание
fields Массив Массив параметров задачи
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php 
$arFields 
= array(
    
"NAME"=>"Самая важная задача",
    
"USER_ID"=>1,
    
"DEADLINE"=>"2025-01-01",
);
$arPost = array("fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/add_activity.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Результат:
Возвращает код созданной задачи
Допустимые параметры задачи:
Параметр Тип Описание
NAME Строка Наименование задачи
STATUS Число Статус задачи
DEADLINE Дата Дэдлайн
DATE_START Дата Дата начала
DEAL_ID Число Код сделки
CONTACT_ID Число Код контакта
USER_ID Число Код сотрудника
REMIND Число Время напоминания. Количество минут до начала выполнения задачи.
ACTIVITY_TYPE Строка Тип задачи
PROP_{код свойства} Определяется типом свойства Пользовательское свойство

Изменение задачи

POST /api/update_activity.php
Параметры:
Параметр Тип Описание
activity_id Число Код задачи
fields Массив Массив параметров задачи
access_token Строка Токен авторизации
app_secret Строка Секретный код
Пример:
<?php
$arFields 
= array(
    
"NAME"=>"Новое наименование задачи",
);
$arPost = array("activity_id"=>1"fields"=>$arFields"access_token"=>$access_token"secret_code"=>$secret_code);
$URL="http://deltacrm.ru/api/update_activity.php";
$out PostRequest($URL$arPost);
$arRes json_decode($outtrue);
?>
Допустимые параметры задачи:
Параметр Тип Описание
NAME Строка Имя
STATUS Число Статус сделки
DEADLINE Дата Дэдлайн
DATE_START Дата Дата начала
DEAL_ID Число Код сделки
CONTACT_ID Число Код контакта
USER_ID Число Код сотрудника
REMIND Число Время напоминания. Количество минут до начала выполнения задачи.
ACTIVITY_TYPE Строка Тип задачи
PROP_{код свойства} Определяется типом свойства Пользовательское свойство


Функция для отправки POST запроса

<?php 
        
function PostRequest($URL$arParams)  {
            
            
$curl=curl_init();
            
curl_setopt($curl,CURLOPT_RETURNTRANSFER,true);
            
curl_setopt($curl,CURLOPT_USERAGENT,'DeltaCRM-API-client/1.0');
            
curl_setopt($curl,CURLOPT_URL,$URL);
            
curl_setopt($curl,CURLOPT_POST,true);
            
curl_setopt($curl,CURLOPT_POSTFIELDS,http_build_query($arPost));
            
curl_setopt($curl,CURLOPT_HEADER,false);
            
curl_setopt($curl,CURLOPT_COOKIEFILE,dirname(__FILE__).'/cookie.txt');                  
            
curl_setopt($curl,CURLOPT_COOKIEJAR,dirname(__FILE__).'/cookie.txt');     
            
curl_setopt($curl,CURLOPT_SSL_VERIFYPEER,0);
            
curl_setopt($curl,CURLOPT_SSL_VERIFYHOST,0);
            
$result=curl_exec($curl);
            
curl_close($curl);
            return 
$result;
            
        }
        
?>
        
По любым возникающим вопросам обращайтесь в техничекую поддержку