Запрос категорий

---

Документация: Работа с категориями

Базовая информация

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

Эндпоинты

1. Получение списка всех категорий

[GET] {domain}/external/category/

Этот эндпоинт возвращает список всех категорий, доступных на сайте.

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

curl --location '<https://admin.ecom.md/external/category/'> \
--header 'API-Token: YOUR_API_TOKEN'

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

[
    {
        "id": 2964,
        "position": 10,
        "name_ro": "Telefoane",
        "name_ru": "Телефоны",
        "name_en": null,
        "name_uk": null,
        "slug_ro": "telefoane-1",
        "slug_ru": "telefony",
        "slug_en": "telefoane-1",
        "slug_uk": "telefoane-1",
        "hide": false,
        "description_ro": null,
        "description_ru": null,
        "description_en": null,
        "description_uk": null,
        "description_position": null,
        "group_category_id": "testing-phone-cat-id",
        "meta_description_ro": null,
        "meta_description_ru": null,
        "meta_description_en": null,
        "meta_description_uk": null,
        "meta_title_ro": null,
        "meta_title_ru": null,
        "meta_title_en": null,
        "meta_title_uk": null,
        "meta_keywords_ro": null,
        "meta_keywords_ru": null,
        "meta_keywords_en": null,
        "meta_keywords_uk": null,
        "show_18_popup": true,
        "category_id": null
    }
]

2. Получение информации о конкретной категории

[GET] {domain}/external/category/{id}

Позволяет получить детальную информацию о конкретной категории по её id.

Параметры пути:

• {id} — уникальный идентификатор категории в базе данных.

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

curl --location '<https://admin.ecom.md/external/category/2964'> \
--header 'API-Token: YOUR_API_TOKEN'

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

{
    "id": 2964,
    "position": 10,
    "name_ro": "Telefoane",
    "name_ru": "Телефоны",
    "name_en": null,
    "name_uk": null,
    "slug_ro": "telefoane-1",
    "slug_ru": "telefony",
    "slug_en": "telefoane-1",
    "slug_uk": "telefoane-1",
    "hide": false,
    "description_ro": null,
    "description_ru": null,
    "description_en": null,
    "description_uk": null,
    "description_position": null,
    "group_category_id": "testing-phone-cat-id",
    "meta_description_ro": null,
    "meta_description_ru": null,
    "meta_description_en": null,
    "meta_description_uk": null,
    "meta_title_ro": null,
    "meta_title_ru": null,
    "meta_title_en": null,
    "meta_title_uk": null,
    "meta_keywords_ro": null,
    "meta_keywords_ru": null,
    "meta_keywords_en": null,
    "meta_keywords_uk": null,
    "show_18_popup": true,
    "category_id": null
}

Поля ответа

Каждая категория содержит следующую информацию:

• id (int): Уникальный идентификатор категории в базе.
• position (int): Позиция категории в меню сайта.
• namero, nameru, nameen, nameuk (string): Название категории на конкретном языке.
• slugro, slugru, slugen, sluguk (string): Уникальный слаг категории на конкретном языке.
• hide (bool): Статус видимости категории (false — категория отображается, true — скрыта).
• descriptionro, descriptionru, descriptionen, descriptionuk (string): Описание категории на конкретном языке.
• description_position (int, nullable): Позиция отображения описания категории.
• groupcategoryid (string): Уникальный идентификатор категории, используемый в вашей системе.
• metadescriptionro, metadescriptionru, metadescriptionen, metadescriptionuk (string): Мета-описание категории на конкретном языке.
• metatitlero, metatitleru, metatitleen, metatitleuk (string): Мета-заголовок категории на конкретном языке.
• metakeywordsro, metakeywordsru, metakeywordsen, metakeywordsuk (string): Мета-ключевые слова категории на конкретном языке.
• show18popup (bool): Отображение окна предупреждения 18+ для данной категории.
• category_id (List[int]): ID родительских категории (при наличии вложенности).

Примечания

• Система языка:
  Если для какого-либо языка категория не указана, возвращаемое значение для полей name, slug, description, meta_* будет равно null.
• Структура ответа:
  Если категория вложена в другую, значение поля category_id соответствует ID родительской категории.

---

Была ли статья полезна?

Да, спасибо! К сожалению, нет