Загрузка...
И так, для чего может понадобится Bitrix API, и с чем его едят.
REST API может подойти для решения ряда задач
- получение данных с вашей битрикс системы
- отправка данных в Bitrix с сайта или приложения
- синхронизация данных из Битрикса с другой CRM системой
Под Bitrix подразумевается не CMS Bitrix, а сервис «Битрикс24».
Для новичков и кому постарше рекомендую установить приложение в вашем битриксе «Документация по REST API» через маркетплейс. После установки приложения в системе появится не только документация по работе, а самое главное это консоль для выполнения команд.
Полезные ссылки
- документация по REST API
- приложение для установки «Документация по REST API«
Так выглядит установленное приложение и консоль
Работа с консолью
Тут все просто, в поле для ввода кода, вставляем код который нужно проверить на работоспособность или просто взять из примера, например получение данных по сделке crm.deal.get
BX24.callMethod(
"crm.deal.get",
{ id: 1 },
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
и жмем на кнопку Run, в результате получаем следующую картину.
где четко видно полученный результат и перечень полей.
Но это все происходит в самой системе, а если нам надо извне выполнить запрос к системе битрикса24, например из php кода расположенного у нас на сайте.
Для этого нужно создать входящий вебхук.
Создание вебхуков
Вебхуки делятся на
- входящие — служит для приема команд из вне, например с сайта
- исходящие — служит для отправки запросов на внешний ресурс, срабатывает только по определенным событиям в системе Bitrix24
Находятся вебхуки в Приложения — Вебхуки
