Документация для разработчиков
Темная тема

app.info

Права на выполнение: для всех

Описание и пример

Показ информации о приложении. Метод поддерживает безопасный вызов.

Пример

Запрос

http://my.bitrix24.ru/rest/app.info?auth=d161f25928c3184678924ec127edd29a

Ответ JSON

{
	"result": {
		"ID":"7",
		"CODE":"local.56017020f07e17.98523769",
		"VERSION":1,
		"STATUS":"L",
		"INSTALLED":true,
		"PAYMENT_EXPIRED":"N",
		"DAYS":null,
		"LICENSE":"ru_project"
	}
}

Ответ XML

<response>
	<result>
		<ID>7</ID>
		<CODE>local.56017020f07e17.98523769</CODE>
		<VERSION>1</VERSION>
		<STATUS>L</STATUS>
		<INSTALLED>1</INSTALLED>
		<PAYMENT_EXPIRED>N</PAYMENT_EXPIRED>
		<DAYS></DAYS>
		<LICENSE>ru_project</LICENSE>
	</result>
</response>

Поля ответа

Поле Описание
ID локальный идентификатор приложения на портале
CODE код приложения
VERSION установленная версия приложения
STATUS статус приложения. Возможные значения:
  • F (Free) - бесплатное;
  • D (Demo) - демо-версия;
  • T (Trial) - триальная версия (ограниченная по времени);
  • P (Paid) - оплаченное приложение;
  • L (Local) - локальное приложение.
  • S (Subscription) - подписное приложение.
INSTALLED [true|false] Статус установленности приложения. Если приложение не установлено, оно доступно только администраторам портала и должно сигнализировать об окончании установки при помощи вызова 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
LICENSE_TYPE Внутреннее обозначение тарифа без указания региона. Нужно, чтобы различать тарифы, состав которых менялся при сохранении публичного наименования (как CRM+, Команда и Компания)
LICENSE_FAMILY Обозначение тарифа без указания региона.

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



© «Битрикс», 2001-2024, «1С-Битрикс», 2024