Получить данные для OAuth 2.0 BX24.getAuth

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

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

Функция BX24.getAuth синхронно возвращает текущие данные авторизации приложения по протоколу OAuth 2.0: токены доступа и обновления, срок их действия и данные Битрикс24, в котором открыто приложение.

Функция работает только после BX24.init и только внутри фрейма приложения. Собственный scope функции не нужен.

Токен для запросов к Битрикс24 библиотека подставляет сама, поэтому перед BX24.callMethod вызывать getAuth не нужно. Данные получают для других задач: связать установку приложения со своим сервером по member_id и domain или передать токены серверу, который обращается к Битрикс24 самостоятельно.

Параметры функции

Без параметров.

Пример кода

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

BX24.init(() => {
    const authInfo = BX24.getAuth();

    if (!authInfo) {
        console.error('B24: authorization data is not available');
        return;
    }

    console.log('B24: member_id: ', authInfo.member_id);
    console.log('B24: token expires at: ', new Date(authInfo.expires_in));
});

Обработка ответа

Функция не принимает обработчик. Успешный результат — объект из пяти полей.

{
    "access_token": "cd4b8566006efd82005fdecc0000000dccbb3dcc7411d1e5878338535115c7e0",
    "refresh_token": "8e1cd566006efd82005fdecc00000000e5a2fd2b1e16dc6a2b3b5a8b1d7a4f19",
    "expires_in": 1720011727002,
    "domain": "mycompany.bitrix24.ru",
    "member_id": "42bc01fbd89dd1d45d13506933f6f4fc"
}

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

Название
тип

Описание

access_token
string

Токен доступа. В запросы к Битрикс24 библиотека подставляет его сама

refresh_token
string

Токен обновления. По нему получают новый access_token после истечения срока действия

expires_in
integer

Момент истечения срока действия access_token — число миллисекунд, прошедших с 1 января 1970 года. Сравнивайте его с Date.now(). Значение не совпадает по смыслу с полем expires_in в ответе OAuth-сервера, где это время жизни токена в секундах

domain
string

Адрес Битрикс24, в котором открыто приложение, например mycompany.bitrix24.ru

member_id
string

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

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

Своих кодов ошибок у функции нет: она не обращается к REST API, а читает данные, которые фрейм приложения получил от Битрикс24 при инициализации. Вместо ошибки функция возвращает false.

Ситуация

Что происходит

Что делать

Функция вызвана до того, как отработала инициализация библиотеки

Возвращает false

Перенести вызов в обработчик BX24.init

Срок действия access_token истек

Возвращает false

Вызвать любой метод Битрикс24: библиотека обновит токен сама. Если свежий токен нужен раньше, вызвать BX24.refreshAuth

Страница открыта не во фрейме приложения

Библиотека не инициализируется: при загрузке она выбрасывает исключение Unable to initialize Bitrix24 JS library!, объект BX24 становится равен null

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

Токены — секрет приложения. Не логируйте access_token и refresh_token и не сохраняйте их в браузерных хранилищах: передавайте на свой сервер и храните там.

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

Предыдущая
Оповестить об окончании работы инсталлятора
Следующая
Принудительно обновить данные авторизации