Získat nastavení webu

GET/api/crm/v2/sites_settingsv2

operationId: sitesSettings.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 8810

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobjectpovinné

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

noticestring

Příklad: message

yandex_metrikastring

Příklad: 314159

listarray of object

idstringpovinné

Složený identifikátor: [page]_[platform]_[type]_[section]

Příklad: all_site_desktop_head

pagestringpovinné

Hodnoty:allaboutfeedbackmainmobidel-trackerpopularrecommendspecial-offersvacancies

Příklad: all

platformstringpovinné

Hodnoty:allsitesocial-app

Příklad: all

typestringpovinné

Hodnoty:alldesktopmobile

Příklad: all

sectionstringpovinné

Hodnoty:headbody

Příklad: head

htmlstringpovinné

Příklad: <meta name='robots' content='index, follow'>

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/sites_settings?branch_id=8810', [ '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_settings?branch_id=8810", { 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_settings?branch_id=8810", 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" } }, "notice": "message", "yandex_metrika": "314159", "list": [ { "id": "all_site_desktop_head", "page": "all", "platform": "all", "type": "all", "section": "head", "html": "<meta name='robots' content='index, follow'>" } ] } }