метод REST scope: placement, в зависимости от точки встраивания

placement.bind

Зарегистрировать обработчик виджета

Кто может выполнять: администратор

Описание

Метод placement.bind регистрирует обработчик виджета в точке встраивания.

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

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

Параметры

PLACEMENT string обязательный

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

HANDLER string обязательный

URL обработчика виджета

TITLE string необязательный

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

DESCRIPTION string необязательный

Описание виджета в интерфейсе. На практике не используется

GROUP_NAME string необязательный

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

LANG_ALL object необязательный

Массив параметров TITLE, DESCRIPTION и GROUP_NAME для указанных языков. Пользователи, у которых в интерфейсе Битрикс24 выбран один из таких языков, будут видеть локализованные версии TITLE, DESCRIPTION и GROUP_NAME:


    "LANG_ALL": {
        "en": {
            "TITLE": "title",
            "DESCRIPTION": "description",
            "GROUP_NAME": "group"
        },
        "ru": {
            "TITLE": "заголовок",
            "DESCRIPTION": "описание",
            "GROUP_NAME": "группа"
        }
    }
OPTIONS object необязательный

Дополнительные параметры отображения виджета. Конкретные значения зависят от точки встраивания. На текущий момент используется в виджетах для мессенджера, в виджете PAGE_BACKGROUND_WORKER и в виджете CRM_XXX_DETAIL_ACTIVITY

USER_ID integer необязательный

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

На текущий момент этот параметр поддерживается только виджетом PAGE_BACKGROUND_WORKER.

При попытке зарегистрировать этот параметр в других точках встраивания вы получите ошибку ERROR_PLACEMENT_USER_MODE: User mode is not available.

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"PLACEMENT":"PLACEMENT_CODE","HANDLER":"http://myapp.com/handler/?type=1","OPTIONS":{"errorHandlerUrl":"http://myapp.com/error/"},"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group","LANG_ALL":{"en":{"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group"},"ru":{"TITLE":"заголовок","DESCRIPTION":"описание","GROUP_NAME":"группа"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/placement.bind

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Возвращаемые данные

result boolean

Возвращает результат добавления обработчика виджета. Возможные значения:

  • True, обработчик успешно зарегистрирован;
  • False, обработчик не зарегистрирован
time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'PLACEMENT' is null or empty",
    "argument": "PLACEMENT"
}
Код Описание Значение
ERROR_PLACEMENT_MAX_COUNT Произошла попытка повторной регистрации обработчика виджета, который допускает только одну регистрацию: PAGE_BACKGROUND_WORKER или REST_APP_URI 200
ERROR_PLACEMENT_USER_MODE Параметр USER_ID передан для виджета, который не поддерживает регистрацию для отдельного пользователя 200
EMPTY_ERROR_HANDLER_URL При регистрации виджета PAGE_BACKGROUND_WORKER не передан обязательный параметр OPTIONS[errorHandlerUrl] 200
ERROR_ARGUMENT Не указано значение обязательного поля. Код обязательного поля возвращается в argument 200
WRONG_AUTH_TYPE Current authorization type is denied for this method Application context required 403

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.