Страницы

Получение списка типов страниц

Метод: GET
URL: https://api.gigma.ru/api/counterparty/page_types
Авторизация: Не требуется
Headers: Authorization: Bearer {token}

Параметры запроса

Передаваемые параметры отсутствуют.

Пример запроса

https://api.gigma.ru/api/counterparty/page_types

Ответ

При успешном действии возвращается HTTP код 200.

{
    "items": [
        {
            "id": 1,
            "name": "Страница",
            "photo": null,
            "created_at": "2024-11-01T19:09:36.000000Z"
        },
        {
            "id": 2,
            "name": "Блок",
            "photo": null,
            "created_at": "2024-11-01T19:09:36.000000Z"
        },
        {
            "id": 3,
            "name": "Новость",
            "photo": null,
            "created_at": "2024-11-01T19:09:36.000000Z"
        }
    ],
    "itemsCount": 3
}

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

items — массив объектов типов страниц
id — идентификатор типа страницы
name — название типа страницы
photo — фото (или null, если отсутствует)
created_at — дата/время добавления в систему
itemsCount — общее количество типов страниц

Получение списка страниц

Метод: GET
URL: https://api.gigma.ru/api/counterparty/pages
Авторизация: Не требуется
Headers: Authorization: Bearer {token}

Параметры запроса

page_type_id — обязательный идентификатор типа страницы (берётся из справочника типов страниц)

Пример запроса

https://api.gigma.ru/api/counterparty/pages?page_type_id=3

Ответ

При успешном действии возвращается HTTP код 200.

{
    "pages": [
        {
            "id": 1,
            "slug": "new-1",
            "title": "Новость 1",
            "description": "Краткое описание новости",
            "preview": {
                "id": 14,
                "name": "preview.jpg",
                "path": "https://api.gigma.ru/storage/uploads/preview.jpg"
            },
            "content": "<p>HTML содержимое страницы</p>",
            "created_at": "2024-11-01T19:09:36.000000Z"
        }
    ],
    "pagesCount": 1
}

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

pages — массив объектов страниц
id — идентификатор страницы
slug — URL-идентификатор страницы
title — заголовок страницы
description — краткое описание страницы
preview — объект с информацией о превью-изображении
content — HTML-разметка страницы
created_at — дата/время добавления в систему
pagesCount — общее количество страниц

Получение выбранной страницы

Метод: GET
URL: https://api.gigma.ru/api/counterparty/pages/{slug}
Авторизация: Не требуется
Headers: Authorization: Bearer {token}

Параметры запроса

Передаваемые параметры отсутствуют.

Пример запроса

https://api.gigma.ru/api/counterparty/pages/new-1

Ответ

При успешном действии возвращается HTTP код 200.

{
    "page": {
        "id": 1,
        "slug": "new-1",
        "title": "Новость 1",
        "description": "Краткое описание новости",
        "preview": {
            "id": 14,
            "name": "preview.jpg",
            "path": "https://api.gigma.ru/storage/uploads/preview.jpg"
        },
        "content": "<p>HTML содержимое страницы</p>",
        "created_at": "2024-11-01T19:09:36.000000Z"
    }
}

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

page — объект страницы (структура аналогична элементу из списка страниц)
id — идентификатор страницы
slug — URL-идентификатор страницы
title — заголовок страницы
description — краткое описание страницы
preview — объект с информацией о превью-изображении
content — HTML-разметка страницы
created_at — дата/время добавления в систему