Bitrix API — что это такое

Битрикс24 — сервис, который включает инструменты для управления бизнесом. Среди них: CRM, Задачи и проекты, Соцсети, Сайты и Офис. Каждый из них отвечает за управление бизнес-процессами, распределение задач между работниками, создание маркетинговые кампании.

API Bitrix — что это такое

Bitrix API — это инструмент для разработчиков приложений, который даёт возможность разработчикам ПО создать приложение или интеграцию. Работа с Rest осуществляется как в облачных версиях продукта, так в коробочных. Для успешной работы с битрикс апи понадобятся базовые знания PHP, HTML, CSS, опыт работы с API и Rest API. Большинство модулей для сборки требуют версию Python не ниже 2.7.

Причём различают два вида API: Bitrix 24 API и 1C-Bitrix API. Каждый предназначен для соответствующей программы, не следует их путать.

1C-Bitrix API

Локальные решения в 1С Битрикс апи принесут наибольшую пользу в ситуациях, когда необходимо разработать пользовательский интерфейс:

• создания отчётов;
• автоматические обработчики данных;
• приложения, которым необходимо регулировать доступ пользователя;
• мессенджеры и программные продукты для взаимодействия с клиентом;

Вебхуки — второй способ расширить системные возможности. Отлично подходят для:

• проведения единовременной загрузки или экспорта данных;
• применения в автоматической обработке событий (пользователь заполнил форму на сайте, отправил письмо в службу поддержки и др.);
• для взаимодействия с системами компании.

Виды локальных приложений

Имеются два типа локальных решений:

• Статичные. Обратившись к битрикс рест апи с помощью Software Development Kit на JavaScript можно создавать одностраничные приложения. В Bitrix Interface они будут отображаться как отдельные страницы.
• Серверные. Приложения обращаются к API по протоколу OAuth 2.0. Могут быть представлены отдельной страницей или в виде модальных диалогов. Обработчики могут получать события от системы.

Пример статичного приложения: страница, на которой будет выведено ФИО авторизованного пользователя. Пример серверного: php-файл, который размещают на сервере для получения ФИО текущего пользователя.

Принцип работы веб-хуков

Принцип работы вебхуков основан на получении и фиксации ключа авторизации. Ключ используют для вызовов методов, причём он действителен в течение неограниченного времени, что выгодно его отличает от токена авторизации OAuth 2.0.

Недостатки работы с веб-хуками:

• Для генерации веб-хука необходимо участие пользователя
• Из-за того, что срок действия ключа неограничен, возникает риск получения доступа к системе сторонними пользователями. Поэтому данный механизм работает только для локальных решений, но не для публичных.
• Часть методов нельзя вызвать при работе через веб-хуки, поскольку для их работы предполагается наличие контекста приложения, которого нет в системе Bitrix24.

Создание веб-хуков

Для добавления вебхука необходимо сделать ряд операций:

1. В меню «Добавить веб-хук» нажать «Входящий веб-хук»
2. В открывшейся странице заполняем данные. В полях «Название» и «Описание» вводится любая информация. «Права доступа» — нужно выбрать модули, к которым сможет обращаться вебхук.
3. Сохранить введенную информацию.
4. Отобразится ключ авторизации.
5. Вместе с ключом будет показан пример ссылки, которую используют для отправки данных в систему.

При помощи ключа можно обращаться к Битрикс из другой системы.

Тиражные приложения

Rest API битрикс24 позволяет разрабатывать тиражные приложения, которые после публикации в каталоге становятся доступными для установки всем пользователям. Их можно предоставлять на платной основе или безвозмездно. К каждому программному продукту предъявляется ряд требований, которые должны быть соблюдены для дальнейшей публикации:

• Модератор проверяет, насколько решение соответствует правилам оформления
• Модерация проводится для каждой из версий приложения
• Автор публикации ответственен за защиту и конфиденциальность персональных данных, к которым программный продукт

Bitrix 24 API

Битрикс API позволяет расширить существующий функционал. В каталоге на странице «Приложения» находится список программ, которые можно установить. Найти нужное приложение можно, нажав на «Фильтр + поиск» в верхней части страницы. Для этого из списка категорий выбирают подходящую. Если известно, указывают, какова стоимость программного продукта, либо диапазон цен.

Если приложение должно быть совместимо с мобильным Битрикс 24, это указывают в соответствующем поле. Для установки понадобятся права администратора. Все установленные программы находятся в разделе «Установленные», где можно проверить наличие обновлений, удалить ненужные приложения.

Что дает открытый API

В процессе работы с системой Битрикс24 может возникнуть запрос на доработку или создание дополнительного функционала. Bitrix24 API позволяет разрабатывать программные продукты как для внутреннего использования компанией, так и для продажи в каталоге готовых решений. В зависимости от цели выбирают подходящие инструменты.

Если доработка выполняется на заказ без дальнейшей публикации, то используют функционал для облегчения интеграции.

Для публикации и распространения разработанного приложения необходимо решить несколько организационных вопросов. Например, продукт должен пройти модерацию на соответствие требованиям системы. В отличие от локальных решений, которые используются только для определенного заказа, тиражные приложения и их публикация регламентируется правилами Битрикс24.

Начиная с 18-ой версии, bitrix rest становится неотъемлемой частью системы, которую нельзя удалить. После последних обновлений появилась поддержка Application Cache.

Документация по API «Битрикс24»

API help bitrix содержит основные сведения о каждом инструменте, использующемся на платформе. Фреймворк даёт возможность создавать проекты в неограниченном количестве, используя одну и ту же лицензию.

Основным разделом является «Главный модуль», в нём приводится описание его настроек, информация о технология и ключевых принципах, положенных в основу системы, а также сведения о классах и функциях. Например, если вызвать метод CUser.main.user.link, то на вывод будет подаваться имя пользователя со сведениями о пользователе соцсети.

Возможно ли получить доступ к rest API Bitrix24, не являясь сертифицированным партнером

Чтобы добавить приложение в каталог решений, необходимо состоять в отношениях технологического партнерства с 1С-Битрикс. Для этого заполняют анкету, где заполняются персональные данные и выбираются логин и пароль для дальнейшей авторизации. Каждому партнеру присваивается код — набор символов.

Если же требуется разработать локальное приложение, которое будет использовано для конкретного проекта, то быть сертифицированным партнёром нет надобности. Администратор сам решает, как будет называться продукт.

Публикация приложения на сервисе

Чтобы открыть публичный доступ к приложению необходимо пройти по следующему древу меню: Кабинет партнера > Приложения24 для Битрикс24 > Добавить приложение.

Далее заполняются поля:

1. Символьный код. Должен быть осмысленным и продуманным, поскольку он будет стоять в адресе каждого из приложений, которое будет опубликовано.
2. Описание приложения, процесса установки и контактные данные можно заполнить после проверки модератором.
3. Тип платного приложения. Есть три режима работа платной версии: демо, триал, без пробной версии. Первый вариант ограничивает функционал продукта до тех пор, пока пользователь не оплатит подписку. В триальной версии пользователь не может пользоваться приложением, если не произвёл оплату в очередной раз. Вариант без подписки подразумевает обязательную оплату перед установкой.
4. Скриншоты. Следует прикрепить хотя бы один скриншот того, как выглядит и работает приложение.
5. Следует ознакомиться с требованиями к публикациям: https://dev.1c-bitrix.ru/docs/solution.php. Без выполнения правил не удастся получить модераторское одобрение.

Нажав на вкладку «Добавить новую версию», можно добавить первую версию решения. Далее заполняют все поля. После этого выполняют загрузку архива с приложением либо указывают ссылку на архивный файл, загруженный на сторонний сайт. Затем кликают «Сохранить». Таким же образом обновляют текущую версию приложения.

Наконец можно подать публикацию на модерацию. Если будут обнаружены какие-либо несоответствия правилам, то должно прийти сообщения в «Обсуждения», а также электронное письмо на почтовый ящик.

Bitrix API — удобный инструмент для разработки приложений, которые используются как для решения задач конкретного проекта, так и для предоставления доступа на платной основе. Готовые решения можно найти в каталоге Приложения24.