Техническая документация
Подробное руководство по использованию BI Data Connector для интеграции Битрикс24 и Power BI
Создание вебхука в Битрикс24
Шаг 1: Переход в раздел REST API
Перейдите в административную панель Битрикс24:
https://ваш-портал.bitrix24.ru/devops/
Или через меню: CRM → Интеграции → Rest API
Шаг 2: Создание нового вебхука
- На вкладке "Готовые сценарии" нажмите "Импортировать/экспортировать данные"
- Выберите "Другое"
- В открывшемся окне:
- Дайте название вебхуку (например: "BI Data Connector")
- Снимите галку "Виджеты"
- Оставьте галку "Входящий вебхук"
Шаг 3: Настройка прав доступа
В разделе "Настройка прав" выберите следующие права:
Шаг 4: Сохранение и получение URL
После нажатия "Сохранить" вы получите URL вебхука вида:
https://ваш-портал.bitrix24.ru/rest/123/abc123def456/
Важно: Сохраните этот URL - он понадобится для подключения шаблона Power BI
Подключение шаблона Power BI
Шаг 1: Получение параметров BI-Аналитики
Перейдите в Битрикс24: CRM → Аналитика → BI-Аналитика
В блоке Microsoft Power BI скопируйте:
- Адрес сервера - понадобится как параметр "Адрес_сервера_Б24"
- Секретный ключ - понадобится как параметр "Секретный_ключ"
Шаг 2: Настройка параметров в Power BI
- Откройте файл шаблона Power BI (.pbit)
- При открытии появится окно с параметрами
- Заполните параметры:
| Параметр | Описание | Пример |
|---|---|---|
| Адрес_сервера_Б24 | Адрес сервера из BI-Аналитики | https://your-portal.bitrix24.ru/rest/bi/... |
| Секретный_ключ | Секретный ключ из BI-Аналитики | abc123def456... |
| Адрес_вебхука | URL созданного вебхука | https://your-portal.bitrix24.ru/rest/123/... |
Шаг 3: Загрузка данных
- Нажмите "Загрузить" в окне параметров
- На все вопросы до начала загрузки отвечайте "Да"
- Дождитесь завершения загрузки данных
- Сохраните файл в формате .pbix
Готово! Ваш отчёт Power BI подключен к данным Битрикс24
Возможности коннектора BI Data
1. Данные через нативный коннектор:
- сделки (
crm_deal) - история сделок (
crm_deal_stage_history) - лиды (
crm_lead) - история лидов (
crm_lead_status_history) - звонки (
telephony_call) - компании (
crm_company) - контакты (
crm_contact) - товарные позиции в лиде (
crm_lead_product_row) - товарные позиции в сделке (
crm_deal_product_row) - пользовательские поля сделок (
crm_deal_uf) - пользовательские поля лидов (
crm_lead_uf) - проекты/группы (
socialnetwork_group) - дела (
crm_activity) - пользователи (
user) - смарт-процессы (
crm_dynamic_items_XXX) - счета (новые) (
crm_item_31) - пользовательские поля контактов (
crm_contact_uf) - пользовательские поля компаний (
crm_company_uf) - задачи (
task) - каталог товаров (
crm_product) - стадии CRM (
crm_stages)
2. Дополнительно по REST API:
- департаменты (
department.get) - направления сделок (
crm.dealcategory.list) - статусы CRM (
crm.status.list) - счета (старые) (
crm.invoice.list) - предложения (
crm.quote.list) - реквизиты (
crm.requisite.list) - разделы товаров (
crm.productsection.list) - универсальные списки (
lists.*) - доп. поля задач (
tasks.task.get) - и другие методы...
Полезные ресурсы:
Создание вебхука
Пошаговая инструкция по созданию вебхука в Битрикс24
Подключение шаблона
Инструкция по подключению шаблона Power BI
Примеры дашбордов
Готовые примеры отчётов и дашбордов
Для партнёров
Информация и материалы для партнёров
Шаблон для разработки
Готовый .pbit файл для разработки отчётов
Презентация (.pdf)
Презентация для партнёров в формате PDF
Поддерживаемые методы BI-Аналитики (основные)
crm_deal– сделкиcrm_lead– лидыcrm_deal_uf– пользовательские поля сделокcrm_lead_uf– пользовательские поля лидовcrm_deal_stage_history– история сделокcrm_lead_status_history– история лидовtelephony_call– звонкиcrm_company– компанииcrm_company_uf– пользовательские поля компанииcrm_contact– контактыcrm_contact_uf– пользовательские поля контактаsocialnetwork_group– проект/группаcrm_activity– делоcrm_lead_product_row– товарные позиции в лидеcrm_deal_product_row– товарные позиции в сделкеcrm_product- товарыcrm_product_property- свойства товаровcrm_product_property_value- значения свойств товаровcrm_dynamic_items_ХХХ- смарт-процессы (зависит от ID)crm_smart_proc- список смарт-процессовcrm_stages- стадии сущностей CRMuser- пользователиtask- задачиtask_stages- стадии задачtask_uf- пользовательские поля задачи
Дополнительные методы REST API (примеры)
crm.invoice.*- счета (старые)crm.item.*- работа с элементами CRM (включая новые счета, предложения, смарт-процессы)crm.status.list- статусыcrm.requisite.*- реквизитыcrm.product.*- товарыcrm.productsection.*- разделы товаровcrm.dealcategory.*- направления сделокtasks.task.*- задачи (новый REST)lists.*- универсальные спискиdepartment.get- структура компании
Функциональные таблицы (служебные)
crm_fields- Структура таблиц BI-Аналитикиcrm_userfields_enum- Значения списочных пользовательских полей BI-Аналитики
Коробочная версия коннектора BI Data
Помимо облачной, представлена коробочная версия коннектора, которая позволяет развернуть его на машинах под управлением Linux или Windows.
- При работе приложения все клиентские данные остаются в вашей инфраструктуре, к нашему серверу коннектор обращается только для проверки лицензии.
- По умолчанию занимает 3000 порт (можно указать другой при запуске в качестве аргумента).
Скачать:
Обращайтесь, предоставим бесплатно триал на 30 дней и поможем с настройкой.
Инструкция для настройки коробочной версии
- Убедитесь, что в Битрикс24 без ограничений работает модуль BI-Аналитика (Путь: CRM -> Аналитика -> BI-Аналитика -> Microsoft Power BI). Если действуют ограничения, появится предупреждение.
- В Битрикс24 создайте вебхук для работы коннектора (Путь: Разработчикам -> Другое -> Вебхуки -> Добавить вебхук -> Входящий вебхук):
- Задайте имя (например, "BI Data Box Connector").
- В "Настройка прав" выберите скоупы:
crm,task(илиtasks),department,user,telephony,lists. - Сохраните и скопируйте URL вебхука (вида
https://yourdomain.bitrix24.ru/rest/XXX/yyyyyyyyyyyy/).
- Запустите исполняемый файл коннектора:
server_bi_data.exe(Windows) или./server_bi_data(Linux). - Откройте файл шаблона Power BI (
box_template.pbix). - Перейдите в Редактор Power Query (Главная -> Преобразование данных).
- Выберите функцию "Данные Б24" (или аналогичную) и заполните параметры:
- Адрес сервера Б24: Скопируйте из CRM -> Аналитика -> BI-Аналитика -> Microsoft Power BI -> "Адрес вашего сервера".
- Секретный ключ: Скопируйте из CRM -> Аналитика -> BI-Аналитика -> Microsoft Power BI -> "Ваш секретный ключ".
- Адрес вебхука: Вставьте URL вебхука, скопированный в п.2.
- Метод CRM Аналитики: Укажите нужный метод из списка поддерживаемых коробочной версией (см. ниже).
- Выбрать столбцы (опционально): Укажите нужные поля через запятую без пробелов (Пример:
ID,DATE_CREATE,TITLE).
- Нажмите "Вызвать" или "Обновить". В результате будет возвращена таблица с данными.
Поддерживаемые методы коробочной версии
- Методы BI-Аналитики:
crm_deal– сделкиcrm_lead– лидыcrm_deal_uf– польз. поля сделокcrm_lead_uf– польз. поля лидовcrm_deal_stage_history– история сделокcrm_lead_status_history– история лидовcrm_company– компанииcrm_company_uf– польз. поля компанииcrm_contact– контактыcrm_contact_uf– польз. поля контактаcrm_activity– делаcrm_lead_product_row– товарные позиции в лидеcrm_deal_product_row– товарные позиции в сделкеtelephony_call– звонки- Методы REST API:
api_user- пользователиapi_department- отделыapi_crm_status- статусыapi_task- задачиapi_crm_product- товары CRMapi_crm_productsection- разделы товаров CRMapi_list- список универсальных списковapi_list_field_<IBLOCK_ID>- поля универсального спискаapi_list_element_<IBLOCK_ID>- элементы универсального спискаapi_crm_invoice- счета (старые)api_crm_category_<entityTypeId>- направления сделок/смарт-процессовapi_crm_item_<entityTypeId>- смарт-процесс
Решение проблем
Ошибка "Не удалось подключиться к источнику данных"
Возможные причины:
- Неверно указан адрес сервера или секретный ключ
- Недостаточно прав у вебхука
- Вебхук был удалён или деактивирован
Решение:
- Проверьте параметры подключения в CRM → Аналитика → BI-Аналитика
- Убедитесь, что вебхук существует и активен
- Проверьте права доступа вебхука
Медленная загрузка данных
Возможные причины:
- Большой объём данных
- Ограничения тарифа Битрикс24
- Сетевые проблемы
Решение:
- Используйте фильтрацию данных по датам
- Рассмотрите переход на коробочную версию
- Оптимизируйте запросы в Power BI
Отсутствуют некоторые поля
Возможные причины:
- Поля не включены в нативный коннектор
- Недостаточно прав доступа
- Поля были удалены в Битрикс24
Решение:
- Используйте REST API методы для получения дополнительных полей
- Проверьте настройки прав вебхука
- Обратитесь в техническую поддержку
Нужна помощь?
Если у вас остались вопросы или нужна техническая поддержка:
- Проверьте раздел FAQ
- Свяжитесь с нашей технической поддержкой
- Закажите индивидуальную консультацию