Статика

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

Административные запросы

Административные запросы предоставляют возможности для добавления, редактирования, публикации и удаления статических элементов и их разделов. Все доступные запросы приведены ниже:

Элементы статики:
  • GET /core/static/items — получить список всех статических элементов.
  • GET /core/static/items/:id — получить данные определенного элемента статики.
  • POST /core/static/items/add — создать новый статический элемент.
  • POST /core/static/items/:id/publish — опубликовать элемент статики.
  • POST /core/static/items/:id — обновить данные статического элемента.
  • POST /core/static/items/:id/delete — удалить статический элемент.
Разделы статики:
  • GET /core/static/sections — получить список всех разделов статики.
  • GET /core/static/sections/:id — получить данные определенного раздела статики.
  • POST /core/static/sections/add — создать новый раздел статики.
  • POST /core/static/sections/:id/publish — опубликовать раздел статики.
  • POST /core/static/sections/:id — обновить данные раздела статики.
  • POST /core/static/sections/:id/delete — удалить раздел статики.
Полное описание каждого запроса доступно в отдельном разделе документации.

Публичные запросы

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

Элементы статики:
GET домен/static/{ имя элемента }
Разделы статики:
GET домен/static/sections/{ имя раздела }

Примеры

Пример запроса элемента статики:
GET
/static/items/test-item

При успешном запросе, ответ будет выглядеть так:

1{
2  "id": 101,
3  "name": "Тестовый элемент",
4  "url": "test-item",
5  "description": "Описание тестового элемента",
6  "active": true,
7  "parentId": null,
8  "hits": 50,
9  "sort": 1
10}

Интерфейс для работы с элементами статики:

1interface IStaticItem {
2  id: number | null;
3  name: string;
4  url: string;
5  description: string;
6  active: boolean;
7  parentId: number | null;
8  hits: number;
9  sort: number;
10}
Пример запроса раздела статики:
GET
/static/sections/test-section

При успешном запросе, ответ будет выглядеть так:

1{
2  "id": 10,
3  "name": "Тестовый раздел",
4  "url": "test-section",
5  "description": "Описание тестового раздела",
6  "active": true,
7  "parentId": null,
8  "hits": 20,
9  "sort": 2
10}

Интерфейс для работы с разделами статики:

1interface IStaticSection {
2  id: number | null;
3  name: string;
4  url: string;
5  description: string;
6  active: boolean;
7  parentId: number | null;
8  hits: number;
9  sort: number;
10}