Mendapatkan pengaturan situs

GET/api/crm/v2/sites_settingsv2

operationId: sitesSettings.default

Otorisasi

api-token + language + role

Parameter permintaan

branch_idintegerwajib

Contoh: 8810

Tanggapan

object

statusstringwajib

Nilai:successerror

Contoh: success

dataobject

filtersobjectwajib

branch_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

noticestring

Contoh: message

yandex_metrikastring

Contoh: 314159

listarray of object

idstringwajib

ID gabungan: [page]_[platform]_[type]_[section]

Contoh: all_site_desktop_head

pagestringwajib

Nilai:allaboutfeedbackmainmobidel-trackerpopularrecommendspecial-offersvacancies

Contoh: all

platformstringwajib

Nilai:allsitesocial-app

Contoh: all

typestringwajib

Nilai:alldesktopmobile

Contoh: all

sectionstringwajib

Nilai:headbody

Contoh: head

htmlstringwajib

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

curl -X GET 'https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: id' \
  -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' => 'id',
        '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": "id",
        "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": "id",
        "role": "partner",
    },
)
data = response.json()

Jawaban 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'>"
      }
    ]
  }
}

Permintaan dikirim ke foodsoul.pro — host dari portal ini, tidak dapat memilih yang lain.