Получить общие настройки приложения app.option.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
базовыйКто может выполнять метод: любой авторизованный пользователь в контексте приложения
Метод app.option.get получает общие настройки приложения, сохраненные через app.option.set. Настройки одни для всех пользователей Битрикс24.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
option |
Один из ключей, сохраненных методом app.option.set. Если параметр не передан, метод вернет все сохраненные настройки приложения |
Примеры кода
Как использовать примеры в документации
Пример №1
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"option": "data",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/app.option.get
Пример №2
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/app.option.get
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type AppOptionResult = Record<string, unknown> | []
// Example 1: get a specific option by key
try {
const response = await $b24.actions.v2.call.make<unknown>({
method: 'app.option.get',
params: {
option: 'data',
},
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('Option value:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
// Example 2: get all options (no parameters)
try {
const response = await $b24.actions.v2.call.make<AppOptionResult>({
method: 'app.option.get',
params: {},
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('All options:', Object.keys(result), 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 getAppOptions() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// Example 1: get a specific option by key
const response1 = await $b24.actions.v2.call.make({
method: 'app.option.get',
params: {
option: 'data',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response1.isSuccess) {
console.error(response1.getErrorMessages().join('; '))
return
}
const result1 = response1.getData().result
console.info('Option value:', result1)
// Example 2: get all options (no parameters)
const response2 = await $b24.actions.v2.call.make({
method: 'app.option.get',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response2.isSuccess) {
console.error(response2.getErrorMessages().join('; '))
return
}
const result2 = response2.getData().result
console.info('All options:', Object.keys(result2), result2)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAppOptions)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.app.option.get(
option="default_language",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример №1
BX24.callMethod(
'app.option.get',
{
"option":"data"
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
Пример №2
BX24.callMethod(
'app.option.get', {},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
Пример №1
require_once('crest.php');
$result = CRest::call(
'app.option.get',
[
'option' => 'data'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример №2
require_once('crest.php');
$result = CRest::call(
'app.option.get',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "app.option.get", b24.Params{
"option": "data",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("app.option.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
Вызов без параметра option — метод возвращает все сохраненные настройки приложения:
{
"result": {
"data": "value",
"data2": "value2"
},
"time": {
"start": 1722001311.94644,
"finish": 1722001311.98622,
"duration": 0.0397801399230957,
"processing": 0.000041961669921875,
"date_start": "2024-07-26T13:41:51+00:00",
"date_finish": "2024-07-26T13:41:51+00:00",
"operating": 0
}
}
Вызов с параметром option — метод возвращает значение одного ключа:
{
"result": "value",
"time": {
"start": 1722001311.94644,
"finish": 1722001311.98622,
"duration": 0.0397801399230957,
"processing": 0.000041961669921875,
"date_start": "2024-07-26T13:41:51+00:00",
"date_finish": "2024-07-26T13:41:51+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
Зависит от параметра
Значение возвращается в том виде, в каком его сохранил app.option.set: строкой, если настройку передавали параметром формы, или с исходным JSON-типом, если передавали в JSON-теле |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied! Application context required"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access denied! Application context required |
Метод вызван вне контекста приложения, например через входящий вебхук |
|
|
|
Access denied! User authorization required |
Запрос выполнен без авторизованного пользователя |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |