REST API Битрикс24

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

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

В карточке приложения нажмем на кнопку «Создать». На этом этапе создается первая версия вашего будущего приложения.

Нужно выбрать тип приложения.

В текущем уроке в качестве примера мы используем приложение, использующее REST API. Зная, с какими методами REST будет работать приложение, мы можем указать нужные скоупы, например, Задачи и CRM. Полный список доступов можно найти в документации.

Скачайте пример, прикрепленный к уроку, и загрузите его на свой сервер так же, как мы это делали на уроках, посвященных локальным интеграциям.

Поле «ссылка на приложение» является обязательным, а «ссылка на установочное приложение» обычно является опциональным, но сейчас мы им тоже воспользуемся. Нажмем кнопку Сохранить, а затем Закрыть. Вернувшись в карточку приложения, мы можем отредактировать название приложения и сохранить изменения

Теперь нам доступна кнопка Протестировать. Открывшаяся страница позволит нам установить приложение на ваш Битрикс24 и протестировать его до публикации в Битрикс24.Маркет.

Но перед этим, нам нужно внести изменения в пример. Не погружаясь пока в особенности работы протокола авторизации OAuth 2.0, скопируем значения из полей client_id, client_secret и вставим их в соответствующие константы в файле settings.php. Входящие вебхуки, которые мы использовали для локальных интеграций, не применимы в решениях для Маркет.

Вернитесь в кабинет разработчика и укажите адрес своего Битрикс24, на котором вы являетесь администратором и нажмите Установить. Произойдет редирект на портал и откроется интерфейс установки приложения. Когда мы опубликуем приложение в каталоге, заполнив описания и прикрепив скриншоты, установка будет выглядеть эффектнее, но сейчас нам лишь нужно убедиться в технической работоспособности приложения. Битрикс24 автоматически откроет приложение после завершения установки, поскольку у нашего приложения есть пользовательский интерфейс.

Теперь давайте посмотрим подробнее, что происходит внутри.

Начнем с файла install.php. Как вы помните, мы указали ссылку на этот файл в поле «ссылка на установочное приложение». Эта страница приложения открывается во фрейме внутри Битрикс24 один раз при установке приложения. Обычно это используется для инициализации данных на стороне приложения, сохранения токенов авторизации в привязке к конкретному порталу Битрикс24 и т.д.

Метод installApp в SDK как раз и занимается сохранением авторизационных токенов и других данных, полученных от портала в POST-запросе. По умолчанию эти данные будут сохранены в текстовый файл. На практике в масовых приложениях для Маркета лучше использовать базу данных. В последующих уроках мы еще вернемся к этому вопросу.

На этой странице наше приложение просто вызывает метод profile, возвращающий информацию о текущем пользователе. А чтобы вызов методов REST работал, наш SDK автоматически получает нужные токены авторизации из файла, который был создан ранее в install.php. В самом коде примера, как вы видите, мы для этого никаких манипуляций не производим.

Скелет приложения готов.

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