Отримати налаштування геокодування

GET/api/crm/v2/integration_geocodingsv2

operationId: integrationGeocodings.default

Повертає провайдерів геокодування. Кожен провайдер має поля налаштувань з ознакою encrypted; для активного провайдера повертаються також і значення, що шифруються, — у замаскованому вигляді.

Авторизація

api-token + language + role

Параметри запиту

branch_idinteger

Приклад: 1

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobjectобов’язковий

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

settingsobject

idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: google

listarray of object

idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: Google

system_namestring

Приклад: Google

sitestringобов’язковий

Приклад: https://developer.tech.yandex.ru

wikistring

Приклад: https://wiki.foodsoul.pro/i/97

fieldsarray of object

encryptedbooleanобов’язковий

Зашифроване поле; для введення використовуйте поле типу «пароль»

Приклад: true

namestringобов’язковий

Приклад: api_key

valuestring

Приклад: secretkey

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_geocodings", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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" } }, "settings": { "id": 1, "name": "google" }, "list": [ { "id": 1, "name": "Google", "system_name": "Google", "site": "https://developer.tech.yandex.ru", "wiki": "https://wiki.foodsoul.pro/i/97", "fields": [ { "encrypted": true, "name": "api_key", "value": "secretkey" } ] } ] } }