Открытие приложения по ссылке REST_APP_URI

Выберите инструмент для разработки с AI-агентом:

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

Scope: placement

У точки нет своей кнопки в интерфейсе. Обработчик вызывается, когда пользователь переходит по ссылке вида /marketplace/view/#APP_CODE#/, которую приложение само разместило в контенте: в сообщении чата, комментарии ленты, описании задачи. Приложение открывается слайдером поверх той страницы, с которой пользователь перешел.

Свои параметры можно добавить прямо в ссылку: они придут обработчику в PLACEMENT_OPTIONS. Так одно приложение открывает разные экраны: карточку документа, отчет, форму согласования.

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

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

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

Код точки встраивания

Место

REST_APP_URI

Слайдер, который открывается при переходе по ссылке /marketplace/view/#APP_CODE#/

Как собрать ссылку

#APP_CODE# — это код приложения, а не идентификатор регистрации обработчика:

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

Свои параметры передавайте в ключе params: /marketplace/view/#APP_CODE#/?params[docId]=42. Имена ключей приложение задает само, значения приходят обработчику строками.

Ссылка срабатывает везде, где Битрикс24 выводит внутренний адрес ссылкой и открывает его слайдером. Обработчик получает адрес исходной страницы в ключе URI, поэтому по нему видно, из какого раздела пользователь пришел.

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

Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса

Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => ru
            [APP_SID] => 9ecab44f06b9efb6c37d7b02180422b2
            [AUTH_ID] => 913374660070f28d001e30ba00000001f0f1073c8a5e2b7d94f16c0a3e58d271
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 81b29b660070f28d001e30ba00000001f0f107e4d1a9b3f508c72e6d95af3b04
            [SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
            [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
            [APPLICATION_SCOPE] => placement
            [member_id] => d897063e1ce7c5eb9f04b9751eef5915
            [status] => L
            [PLACEMENT] => REST_APP_URI
            [PLACEMENT_OPTIONS] => {"test":"y","docId":"42","URI":"\/company\/personal\/user\/1\/blog\/"}
        )
        

Пример снят для ссылки /marketplace/view/#APP_CODE#/?params[test]=y&params[docId]=42, по которой перешли из ленты новостей.

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

Параметры в query-строке адреса обработчика

Параметр
тип

Описание

DOMAIN*
string

Адрес Битрикс24, на котором был вызван обработчик виджета

PROTOCOL*
string

Защищенный или незащищенный протокол HTTP:

  • 0 — HTTP
  • 1 — HTTPS

LANG*
string

Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своем виджете, ориентируясь на это значение

APP_SID*
string

Идентификатор сессии приложения. Битрикс24 создает его заново при каждой отрисовке виджета и использует, чтобы связать js-библиотеку с окружением приложения

Параметры в теле POST-запроса

Параметр
тип

Описание

AUTH_ID
string

Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя

AUTH_EXPIRES
integer

Время в секундах, после которого авторизационный токен станет неактуальным

REFRESH_ID
string

Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя

SERVER_ENDPOINT*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2

APPLICATION_TOKEN*
string

Токен приложения. То же значение приходит в параметре application_token при вызове обработчиков событий. По нему обработчик виджета может проверить, что запрос пришел от Битрикс24

APPLICATION_SCOPE*
string

Список скоупов, выданных приложению, через запятую. Показывает, какие методы REST API доступны с полученным авторизационным токеном

member_id*
string

Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета

status
string

Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения:

PLACEMENT*
string

Код точки встраивания. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре PLACEMENT, поможет определить, из какой именно точки встраивания был вызван ваш обработчик в каждом конкретном случае

PLACEMENT_OPTIONS
string

Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и так далее. Параметр PLACEMENT_OPTIONS вместе с параметром PLACEMENT позволяет точно определить, для какой именно точки встраивания и какого объекта был вызван обработчик виджета

Битрикс24 добавляет в PLACEMENT_OPTIONS ключ URI — путь с query-строкой той страницы, с которой открыт виджет. Он приходит для любой точки встраивания, вместе с ее собственными ключами. Ключа не будет, если браузер не передал заголовок Referer или виджет открыт со страницы другого домена.

Как разобрать контекст вызова

PLACEMENT_OPTIONS приходит JSON-строкой, а не массивом: перед использованием разберите ее на стороне обработчика. Состав ключей у каждой точки свой и описан в разделе PLACEMENT_OPTIONS этой страницы.

$placement = $_POST['PLACEMENT'] ?? '';
        $options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
        
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")
        

В B24JsSDK разбирать строку не нужно: свойство $b24.placement.options возвращает готовый объект, а $b24.placement.placement — код точки встраивания.

Что должен вернуть обработчик

Обработчик отвечает обычной HTML-страницей — Битрикс24 показывает ее во фрейме на месте виджета. Страница должна разрешать встраивание: если сервер приложения отдает заголовки X-Frame-Options или Content-Security-Policy, запрещающие фрейм, на месте виджета останется пустая область. Как это исправить, описано в статье Сайт не разрешает подключение.

PLACEMENT_OPTIONS

Значение PLACEMENT_OPTIONS передается как JSON-строка. В нее попадают ключи из params вашей ссылки и универсальный ключ URI.

Параметр

Описание

Ключи из params
string

Значения, которые приложение задало в ссылке. Имена ключей произвольные, значения приходят строками

URI*
string

Путь с query-строкой той страницы Битрикс24, с которой пользователь перешел по ссылке

Ключ URI Битрикс24 добавляет сам, но чужое значение не перезаписывает. Если приложение передаст свой ключ URI в params, обработчик получит именно его.

OPTIONS при регистрации через placement.bind

Точка не поддерживает параметр OPTIONS метода placement.bind: переданные значения не сохраняются, и placement.get возвращает пустой массив. Настройки передавайте в адресе обработчика или в ключе params ссылки.

Параметр USER_ID точка тоже не поддерживает: попытка зарегистрировать обработчик для одного пользователя возвращает ошибку ERROR_PLACEMENT_USER_MODE. Обработчик всегда регистрируется для всех пользователей Битрикс24.

Приложение регистрирует только один обработчик этой точки. Повторный вызов placement.bind возвращает ошибку ERROR_PLACEMENT_MAX_COUNT. Чтобы сменить адрес обработчика, сначала снимите регистрацию методом placement.unbind.

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "REST_APP_URI",
            "HANDLER": "https://your-domain.com/widgets/app-uri-handler.php",
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/placement.bind
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'placement.bind',
            params: {
              PLACEMENT: 'REST_APP_URI',
              HANDLER: 'https://your-domain.com/widgets/app-uri-handler.php',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Placement bound successfully:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function bindAppUri() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'placement.bind',
                params: {
                  PLACEMENT: 'REST_APP_URI',
                  HANDLER: 'https://your-domain.com/widgets/app-uri-handler.php',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Placement bound successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindAppUri)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'REST_APP_URI',
                        'HANDLER' => 'https://your-domain.com/widgets/app-uri-handler.php',
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding placement: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'REST_APP_URI',
                HANDLER: 'https://your-domain.com/widgets/app-uri-handler.php'
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'REST_APP_URI',
                'HANDLER' => 'https://your-domain.com/widgets/app-uri-handler.php',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
        	"PLACEMENT": "REST_APP_URI",
        	"HANDLER":   "https://your-domain.com/widgets/app-uri-handler.php",
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // Ответ приходит как json.RawMessage — разберите его по форме ответа
        // метода placement.bind, см. раздел «Обработка ответа» на его странице.
        fmt.Printf("%s\n", res.Result)
        

Связь с другими объектами

Контент, в котором живет ссылка. Ссылку приложение размещает теми же методами, что и любой другой текст: в сообщении чата методами раздела Чаты в Битрикс24: обзор методов, в сообщении ленты методами раздела Лента новостей: обзор методов, в описании задачи методами раздела Задачи: обзор методов.

Интерфейс приложения. Слайдером управляют методы JavaScript для виджетов: closeApplication закрывает виджет, openApplication открывает его заново с другими параметрами.

Типовые ошибки

Ошибка

Как решить

По ссылке открывается пустой слайдер

Проверьте, что приложение установлено и активно: обработчик подставляется только установленному приложению

Слайдер открывается, но параметры не приходят

Параметры передаются только в ключе params: ?params[docId]=42. Ключи, переданные напрямую в query-строке, в PLACEMENT_OPTIONS не попадают

placement.bind возвращает ERROR_PLACEMENT_MAX_COUNT

Обработчик уже зарегистрирован. Снимите старую регистрацию методом placement.unbind

В ссылке указан идентификатор регистрации обработчика

В адресе нужен код приложения: символьный код тиражного или client_id локального

Продолжите изучение