Основные запросы

Данный раздел содержит подробное описание всех эндпоинтов API, предоставляемых платформой. Здесь вы найдете информацию о каждом запросе, включая его назначение, параметры и примеры использования.

API разделен на два основных типа запросов: Административные и Публичные, что обеспечивает гибкость в работе с данными и их управлении.

• Административные запросы — предназначены для работы с ключевыми сущностями системы, включая создание, редактирование, удаление и управление базовыми данными платформы. Они используются для настройки внутренних процессов.

  Административные эндпоинты работают с системными данными, такими как коллекции, страницы, разделы и статические элементы.
  Примеры административных эндпоинтов:
  • GET /core/collections/ — получение информации о коллекциях данных.
  • POST /core/pages/items/add — создание новой страницы платформы.
  • DELETE /core/static/items/:id — удаление статического элемента.
  • GET /core/history/ — просмотр истории запросов.
• Публичные запросы — используются для работы с динамическими данными, хранящимися в системе. Эти эндпоинты обеспечивают доступ к данным, необходимым для взаимодействия с внешними сервисами и интерфейсами.
  Публичные запросы формируются динамически в зависимости от структуры данных и могут быть использованы для получения информации о клиентах, товарах и других сущностях.
  Примеры публичных эндпоинтов:
  • GET /api/products/ — получение списка товаров.
  • GET /api/pages/items/:id — получение информации о конкретной странице.
  • GET /api/customers/ — данные о клиентах.

Маски запросов

При генерации данных сервер использует стандартизированную структуру маски запроса, которая позволяет легко обрабатывать данные независимо от типа запроса или его назначения.

Структура маски запросов:

1interface IRequestData {
2  status: "success" | "error";
3  error ? : {
4    title: string;
5    text: any;
6  };
7  fields ? : {
8    name: string;
9    message: string;
10  } [];
11  payload ? : any;
12  sort ? : {
13    by: string;
14    order: "ASC" | "DESC";
15  };
16  pagination ? : {
17    limit: number;
18    offset: number;
19    total: number;
20  };
21  filter ? : {
22    field: string;
23    value: string;
24  } [];
25}

Описание ключевых полей

• status — Определяет, успешно ли выполнен запрос ("success" / "error").
• error — Описание ошибки, если запрос завершился неудачно.
• fields — Поля, которые вызвали ошибки валидации (если есть).
• payload — Основная полезная нагрузка ответа при успешном запросе.
• sort — Сортировка данных (поле и порядок).
• pagination — Параметры пагинации, включая общее количество записей и лимиты.
• filter — Примененные фильтры.

Для работы с API необходимо учитывать обязательные параметры запросов, описанные для каждого эндпоинта. Примеры запросов с тестовыми данными помогут в интеграции и тестировании.

Более детальное описание запросов представлено в соответствующих разделах документации.