OXBOX Help

Инициализация приложения

При запуске приложения или авторизации, на сервер отправляется запрос admin -> get-system-components, в ответ на который получаются следующие настройки приложения:

{ theme?: "2023" | "flowerbloom", messengers?: boolean, dialog_widget?: { groups: { object: string, property: string }, chats: { object: string, property: string }, messages: { object: string }, }, lang?: "ru" | "en" | "lat", currency?: string, phone_format?: "ru" | "usa" | "lat", global_search?: boolean, sign_up?: boolean, dom_ru?: boolean, google_places?: string, salary_widget?: boolean, footer?: boolean, variables?: "single" | "multiple", domain?: string }
  • theme - Отличная от базовой тема приложения.

  • messengers - Наличие модуля Messenger в приложении.

  • dialog_widget - Наличие модуля Dialog в приложении. объект со свойствами groups, chats, messages, выраженными в виде объектов со свойствами object (объект запроса), property (название свойства для дочернего запроса).

  • lang - Язык приложения.

  • currency - Символ валюты, используемый в приложении.

  • phone_format - Формат телефона в приложении.

  • global_search - Наличие глобального поиска в приложении.

  • sign_up - Наличие формы регистрации.

  • dom_ru - Наличие модуля ip-телефонии в приложении. Подробнее: [[Dom_ru]].

  • google_places - api-ключ для работы с полем GooglePlaces.

  • salary_widget - Наличие в шапке приложения модуля, отображающего зарплату (для зарплат с kpi). Подробнее: [[Salary_widget]].

  • footer - Наличие нижнего блока приложения.

  • variables - Значение регулирует работу со списком переменных в модуле Documents, а именно - даёт возможность выставлять переменные любого объекта базы данных.

  • domain - Свойство, выступающее в качестве фильтра изначального списка мессенджеров для модуля Messenger.

Пример ответа:

{ "status": 200, "data": { "salary_widget": true, "lang": "ru", "messengers": false }, "detail": [] }

Формирование url-адреса для взаимодействия с сервером описано в разделе [[Формирование ссылки api]].

Если пользователь был авторизован, следует разовый запрос на получение данных по авторизованному пользователю. Подробнее: [[Модель пользователя]].

15 мая 2025