Приложение/Система (application) - Совокупность Объектов, Команд и Страниц
Объекты (objects) - Части Системы, с которыми можно взаимодействовать Например: пользователи, товары, записи
Команды (commands) - Действия, которые может проводить Пользователь с Приложением Например: создать задачу, удалить товар, изменить время записи к врачу
Модули (modules) - Независимые компоненты Системы, которые могут подключаться или отключаться в зависимости от требований заказчика Список доступных модулей формируется в OxCRM. Там же модули подключаются к подписчикам
Пользователи (users) - Лица, которые имеют доступ к Системе
Логи (logs) - История действий Пользователей в Системе
Св-ва (properties) - Составные части Объектов и Таблиц Например: у Объекта “Пользователи” есть св-ва “имя”, “фамилия”, “телефон”
Поля (fields) - Составные части форм в Админке Например: у формы записи есть поля “клиент”, “время начала записи”, галочка “недееспособность”
Схемы (schemes) - Файлы json, в которых содержится информация о структуре Объектов, Команд, Страниц, Баз данных
Структура запросов
Название
Тип
Описание
object*
string
Объект, к которому будет направлен запрос
command*
string
Команда, которая будет исполнена
data
object
Тело запроса
Статус
Описание
200
Успешный запрос
400
Некорректный запрос
403
Недостаточно прав
500
Ошибка сервера
Жизненный цикл запроса
Первые шаги
Точкой входа для всех запросов к приложению OxAPI является файл /index.php. Все запросы направляются в этот файл конфигурацией веб-сервера (Apache + Nginx). Файл index.php не содержит большого количества кода. Скорее, это отправная точка для загрузки остальной части фреймворка.