Info

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

В данном разделе описываются методы /api/v1/info/* для получения информации о сервере.

💡
Методы этого раздела не требуют авторизации.

Endpoints

Endpoint
Метод
Описание
Queries
Body (JSON)
Значение поля data
Права (ресурс)
Версия
GET

Получение информации о сервере

Info

1.36.3 — изменен формат данных (начиная с этой версии он стандартный, как для всех других методов)

GET

Возвращает лицензионную информацию по модулю :name или null, если в лицензии нет данного модуля. Может использоваться для проверки лицензии кастомных модулей

Module

1.40.1

GET

Возвращает строку с номером версии. ВАЖНО: нестандартный формат ответа

version: string - (не в поле дата!)

1.37.1

GET

Проверяет, если требуемая версия :version подходит к текущей версии сервера. ВАЖНО: не стандартный формат ответа

true | false

1.37.1

Параметры URL

Name
Описание
Тип значения

Имя модуля для проверки лицензии

string

Версия сервера, которую нужно сравнить с текущей. Версия в формате semver (например, 1.37.0)

string

Описание типов

type Info = {
  company: string, // Имя компании, на которую выдана лицензия
  date: string, // Дата выдачи лицензии
  sma?: string, // Дата, до которой действует SMA
  'valid-till'?: string, // Дата, до которой действует лицензия
  'calendar-systems'?: number, // Количество лицензированных календарных систем
  directories?: number, // Количество служб лицензированных каталогов
  devices?: number, // Количество служб лицензированных устройств
  venues?: number, // Количество служб лицензированных помещений
  serverInfo: {
    version: string, // Версия сервера
    branch: string, // Ветка, из которой он был собран
    buildDate?: string, // Дата сборки
    buildTime?: string, // Время сборки
    isoDate?: TDateISO, // Дата и время сборки в формате ISO-string
    refName?: string,
    commitHash: string, // sha коммит
    dev: boolean // Запущен ли сервер как development
  }
};

type Module = {
  name: string; // Имя модуля
  type?: string; // Тип, custom — для модулей клиентов
  title?: string; // Произвольное описание
  [key: string]: any; // Дополнительные поля
};