Показать информацию о приложении app.info

Scope: базовый

Кто может выполнять метод: любой пользователь

Метод app.info возвращает информацию о приложении.

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/app.info
        
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.info
        
try
        {
        	const response = await $b24.callMethod(
        		'app.info',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $applicationInfoResult = $serviceBuilder->getMainScope()->main()->getApplicationInfo();
            $itemResult = $applicationInfoResult->applicationInfo();
            print("ID: " . $itemResult->ID . PHP_EOL);
            print("Code: " . $itemResult->CODE . PHP_EOL);
            print("Scope: " . json_encode($itemResult->SCOPE, JSON_THROW_ON_ERROR) . PHP_EOL);
            print("Version: " . $itemResult->VERSION . PHP_EOL);
            print("Status: " . $itemResult->getStatus()->getStatusCode() . PHP_EOL);
            print("Installed: " . ($itemResult->INSTALLED ? 'true' : 'false') . PHP_EOL);
            print("Payment Expired: " . $itemResult->PAYMENT_EXPIRED . PHP_EOL);
            print("Days: " . $itemResult->DAYS . PHP_EOL);
            print("License: " . $itemResult->LICENSE . PHP_EOL);
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage() . PHP_EOL);
        }
        
BX24.callMethod(
            "app.info",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'app.info',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "ID": 5,
                "CODE": "telefum24.kp10",
                "VERSION": 4,
                "STATUS": "F",
                "INSTALLED": true,
                "PAYMENT_EXPIRED": "N",
                "DAYS": null,
                "LANGUAGE_ID": "ru",
                "LICENSE": "ru_ent10000",
                "LICENSE_TYPE": "ent10000",
                "LICENSE_FAMILY": "ent"
            },
            "time": {
                "start": 1722841503.0585,
                "finish": 1722841503.09885,
                "duration": 0.0403509140014648,
                "processing": 0.00533103942871094,
                "date_start": "2024-08-05T07:05:03+00:00",
                "date_finish": "2024-08-05T07:05:03+00:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Объект содержит информацию о приложении:

  • ID — локальный идентификатор приложения на портале
  • CODE — код приложения
  • VERSION — установленная версия приложения
  • STATUS — статус приложения. Возможные значения:
    • F (Free) — бесплатное
    • D (Demo) — демо-версия
    • T (Trial) — триальная версия (ограниченная по времени)
    • P (Paid) — оплаченное приложение
    • L (Local) — локальное приложение
    • S (Subscription) — подписное приложение
  • INSTALLED — [true|false] cтатус установленности приложения. Если приложение не установлено, оно доступно только администраторам портала и должно сигнализировать об окончании установки при помощи вызова BX24.installFinish
  • PAYMENT_EXPIRED — [Y|N] флаг, показывающий, истек ли оплаченный период или период триального использования
  • DAYS — количество дней, оставшееся до конца оплаченного периода или периода триального использования
  • LICENSE — обозначение тарифа с указанием региона в виде префикса.Состоит из базового языка портала и идентификатора тарифного плана. В случае с тарифами, состав которых менялся при сохранении публичного наименования (как CRM+, Команда и Компания), понять, какой именно тариф действует по этому полю нельзя. Примеры вариантов значений:
    • ru_project — тариф Проект
    • ru_basic — тариф Базовый
    • ru_std — тариф Стандартный
    • ru_pro100 — тариф Профессиональный
    • ru_ent250 — Энтерпрайз 250
    • ru_ent500 — Энтерпрайз 500
    • ru_ent1000 — Энтерпрайз 1000
    • ru_ent2000 — Энтерпрайз 2000
    • ru_ent10000 — Энтерпрайз 10000

time
time

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

По истечении оплаченного периода приложение продолжит работать в течение периода, отводимого на возможные задержки поступления оплаты (grace period), по окончании которого будет автоматически переключено на демо-режим или заблокировано. При этом значение флага PAYMENT_EXPIRED будет равен Y, а поле DAYS будет содержать отрицательное число.

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

HTTP-статус: 400

{
            "error":"ACCESS_DENIED",
            "error_description":"Access denied! Application context required"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Cообщение об ошибке

Описание

ACCESS_DENIED

Access denied! Application context required

Метод вызван вне контекста приложения

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Получить список доступных разрешений
Следующая
Получить названия прав доступа