Ottenere le categorie SEO

GET/api/crm/v2/sites_seo_categoriesv2

operationId: sitesSeoCategories.default

Restituisce i campi SEO delle categorie. Se download=yes, i dati vengono restituiti come file CSV.

Autorizzazione

api-token + language + role

Parametri della richiesta

page_numberinteger

Esempio: 1

branch_idinteger

Esempio: 8778

downloadstring

Valori:yes

Esempio: yes

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

listarray of object

idintegerobbligatorio

Esempio: 18103940

namestringobbligatorio

Esempio: Rolls

seo_friendly_urlstringobbligatorio

Esempio: roll

seo_h1string

Esempio: Rolls

seo_breadcrumbstring

Esempio: Rolls

seo_titlestring

Esempio: Rolls

seo_keywordsstring

Esempio: rolls, shrimp

seo_descriptionstring

Esempio: Rolls in Kaliningrad

seo_textstring

HTML

Esempio: <p>Rolls in Kaliningrad<p>

paginationobject (Pagination)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/sites_seo_categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "it", "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 } } }