Obter configurações do site

GET/api/crm/v2/sites_settingsv2

operationId: sitesSettings.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8810

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobjectobrigatório

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

noticestring

Exemplo: message

yandex_metrikastring

Exemplo: 314159

listarray of object

idstringobrigatório

Identificador composto: [page]_[platform]_[type]_[section]

Exemplo: all_site_desktop_head

pagestringobrigatório

Valores:allaboutfeedbackmainmobidel-trackerpopularrecommendspecial-offersvacancies

Exemplo: all

platformstringobrigatório

Valores:allsitesocial-app

Exemplo: all

typestringobrigatório

Valores:alldesktopmobile

Exemplo: all

sectionstringobrigatório

Valores:headbody

Exemplo: head

htmlstringobrigatório

Exemplo: <meta name='robots' content='index, follow'>

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "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'>" } ] } }