Виджет в виде ссылки со слайдером REST_APP_URI

Scope: placement

Эта встройка не имеет в интерфейсе отдельной заранее известной кнопки, которая позволяет пользователю открыть её самостоятельно. Приложение может просто отправить ссылку особого формата в любой инструмент Битрикс24, поддерживащий добавление контента со ссылками:

Сообщения и комментарии новостной ленты;
Сообщения внутренних групповых и индивидуальных чатов (не будет работать в диалогах открытых линий);
Описания задач и комментарии к ним;
Описания встреч календаря;
И т.д.

Для использования данной встройки ссылка должна быть в формате /marketplace/view/#APP_CODE#/, где #APP_CODE#:

символьный код вашего тиражного приложения из кабинета разработчика, который задаётся в карточке приложения;
client_id локального приложения (например, local.66ba434d853c87.18550109), который можно скопировать из настроек приложения в разделе Разработчикам.

Встройка может принимать любое количество произвольных параметров в get ключе params, например: /marketplace/view/#APP_CODE#/?params[test]=y. В этом случае PLACEMENT_OPTIONS будет следующий:


        [PLACEMENT_OPTIONS] => {"test":"y"}

Код встройки виджета указывается в параметре PLACEMENT метода placement.bind.

Встройка не будет отображаться в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения

Куда встраивается виджет

Код встройки	Место
`REST_APP_URI`	Конкретное место встройки, фактически, не указывается на этапе добавления обработчика виджета, поскольку виджет будет открываться при клике на любые ссылки особого формата, описанного выше

Что получает обработчик

Данные передаются в виде POST-запроса


        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 195ec4ee87932d8f9bbbd6a2f0a83553
            [AUTH_ID] => f27bbb6600705a0700005a4b00000001f0f107398c3f17f5fc48d5ce194d5c65de7cfb
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => e2fae26600705a0700005a4b00000001f0f1075f986dbd8dff24c36c2ad9bb0816a665
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => REST_APP_URI
            [PLACEMENT_OPTIONS] => {"test":"y"}
        )

Обязательные параметры отмечены *

Параметр `тип`	Описание
DOMAIN* `string`	Адрес Битрикс24, на котором был вызван обрабтчик виджета
PROTOCOL* `string`	Защищенный или не защищенный протокол HTTP: `0` - HTTP `1` - HTTPS
LANG* `string`	Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своём виджете, ориентируясь на это значение
APP_SID `string`	Строковый идентификатор приложения, зарегистрировавшего обработчик виджета
AUTH_ID `string`	Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя
AUTH_EXPIRES `integer`	Время в секундах, после которого авторизационный токен станет неактуальным
REFRESH_ID `string`	Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя
member_id* `string`	Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета.
status `string`	Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения: `L` - локальное приложение `F` - бесплатное тиражное приложение `S` - подписное тиражное приложение
PLACEMENT* `string`	Код места встройки виджета. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре `PLACEMENT`, поможет определить, из какого именно места встройки виджета был вызван ваш обработчик в каждом конкретном случае
PLACEMENT_OPTIONS `string`	Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и т.д. Параметр `PLACEMENT_OPTIONS` вместе с параметром `PLACEMENT` позволяет точно определить, для какого именно места встройки виджета и объекта был вызван обработчик виджета.

PLACEMENT_OPTIONS

Значением PLACEMENT_OPTIONS является JSON-строка, содержащая массив из одного и более ключей, которые были указаны в параметре params у конкретной ссылки, как описано выше.

Это означает, что задавая в своих ссылках и обрабатывая полученный GET-параметр params в обработчике виджета, вы можете реализовыывать любую нужную бизнес-логику.

Частые кейсы и сценарии