Získat SEO kategorie

GET/api/crm/v2/sites_seo_categoriesv2

operationId: sitesSeoCategories.default

Vrací SEO pole kategorií. Pokud je download=yes, výstup je vrácen jako CSV soubor.

Autorizace

api-token + language + role

Parametry dotazu

page_numberinteger

Příklad: 1

branch_idinteger

Příklad: 8778

downloadstring

Hodnoty:yes

Příklad: yes

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object

idintegerpovinné

Příklad: 18103940

namestringpovinné

Příklad: Rolls

seo_friendly_urlstringpovinné

Příklad: roll

seo_h1string

Příklad: Rolls

seo_breadcrumbstring

Příklad: Rolls

seo_titlestring

Příklad: Rolls

seo_keywordsstring

Příklad: rolls, shrimp

seo_descriptionstring

Příklad: Rolls in Kaliningrad

seo_textstring

HTML

Příklad: <p>Rolls in Kaliningrad<p>

paginationobject (Pagination)

max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } } }