Получить SEO категорий

GET/api/crm/v2/sites_seo_categoriesv2

operationId: sitesSeoCategories.default

Возвращает SEO-поля категорий. При download=yes выборка возвращается CSV-файлом.

Авторизация

api-token + language + role

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

page_numberinteger

Пример: 1

branch_idinteger

Пример: 8778

downloadstring

Значения:yes

Пример: yes

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

listarray of object

idintegerобязательный

Пример: 18103940

namestringобязательный

Пример: Rolls

seo_friendly_urlstringобязательный

Пример: roll

seo_h1string

Пример: Rolls

seo_breadcrumbstring

Пример: Rolls

seo_titlestring

Пример: Rolls

seo_keywordsstring

Пример: rolls, shrimp

seo_descriptionstring

Пример: Rolls in Kaliningrad

seo_textstring

HTML

Пример: <p>Rolls in Kaliningrad<p>

paginationobject (Pagination)

max_countintegerобязательный

Количество элементов на странице

Пример: 30

page_numberintegerобязательный

Номер текущей страницы; ограничен так, чтобы смещение не превышало 1000

Пример: 1

has_nextbooleanобязательный

Есть ли следующая страница

Пример: true

has_previousbooleanобязательный

Есть ли предыдущая страница

Пример: false

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/sites_seo_categories', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/sites_seo_categories", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/sites_seo_categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "list": [ { "id": 18103940, "name": "Rolls", "seo_friendly_url": "roll", "seo_h1": "Rolls", "seo_breadcrumb": "Rolls", "seo_title": "Rolls", "seo_keywords": "rolls, shrimp", "seo_description": "Rolls in Kaliningrad", "seo_text": "<p>Rolls in Kaliningrad<p>" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }