API für Partner › Verwaltung Website-Einstellungen abrufen GET /api/crm/v2/sites_settingsv2
operationId: sitesSettings.default
Autorisierung api-token + language + role
Abfrageparameter branch_id integer erforderlich
Beispiel: 8810
Antworten 200
object
status string erforderlich
Werte: successerror
Beispiel: success
data object
filters object erforderlich
branch_id object (FilterSelectInteger)
value integer
Beispiel: 8920
type string erforderlich
Beispiel: select
option array of object
value integer erforderlich
Beispiel: 8920
name string erforderlich
Beispiel: Green Basket | Kaliningrad
mode string (FilterMode)
Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.
Werte: force_shownvalue_required
Beispiel: value_required
notice string
Beispiel: message
yandex_metrika string
Beispiel: 314159
list array of object
id string erforderlich
Zusammengesetzte Kennung: [page]_[platform]_[type]_[section]
Beispiel: all_site_desktop_head
page string erforderlich
Werte: allaboutfeedbackmainmobidel-trackerpopularrecommendspecial-offersvacancies
Beispiel: all
platform string erforderlich
Werte: allsitesocial-app
Beispiel: all
type string erforderlich
Werte: alldesktopmobile
Beispiel: all
section string erforderlich
Werte: headbody
Beispiel: head
html string erforderlich
Beispiel: <meta name='robots' content='index, follow'>
curl PHP JavaScript Python Kopieren
curl -X GET 'https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810' \
-H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
-H 'language: de' \
-H 'role: partner' <?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' => 'de' ,
'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" : "de" ,
"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" : "de" ,
"role" : "partner" ,
},
)
data = response . json () Antwort 200
{
"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'>"
}
]
}
} Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.