Отримати налаштування інтеграції з системою автоматизації

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Авторизація

api-token + language + role

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

branch_idinteger

Приклад: 8922

Відповіді

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

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

Приклад: 1

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

Приклад: 1

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

Приклад: true

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

Приклад: true

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

Приклад: 3.5

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

Приклад: f20138c54eaaad6c00ac77d27b2f4cb4

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

Приклад: FS

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

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

Приклад: true

districts_settingsarray of object

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

У налаштувань за замовчуванням id дорівнює 0

Приклад: 0

terminalstring

Ключ поля форми district_data_${district_id}_terminal

Приклад: terminal1

deliverystring

Ключ поля форми district_data_${district_id}_delivery

Приклад: delivery1

pickups_settingsarray of object

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

За замовчуванням для налаштувань id дорівнює 0

Приклад: 0

terminalstring

Ключ поля форми pickup_data_${pickup_id}_terminal

Приклад: terminal1

listarray of object

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

Приклад: 1

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

Приклад: FrontPad

fieldsarray of object

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

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

Приклад: true

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

Приклад: api_key

valueoneOf

Один із варіантів

string

URL, имя файла или токен — для type=radio/select/file

Приклад: secret

typestring

Значення:switchradiocheckboxselectfile

Приклад: switch

valuesarray of string

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

Приклад: true

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

Приклад: true

sitestring

Приклад: https://frontpad.ru/

wikistring

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

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

Значення:nomanualautomatic

Приклад: no

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

Приклад: true

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

Приклад: true

system_namestring

Приклад: front_pad

webhookstring

Приклад: https://ru.foodsoul.test/webhook/automation/front_pad/?token=f20138c54eaaad6c00ac77d27b2f4cb4

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/integration_automations', [ '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_automations", { 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_automations", 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": { "chain_id": 1, "automation_id": 1, "automation_enabled": true, "automation_error_notifications_enabled": true, "price_sms": "3.5", "token": "f20138c54eaaad6c00ac77d27b2f4cb4", "project_name_short": "FS", "phone_clean_enabled": true, "phone_plus_delete_enabled": true, "phone_space_delete_enabled": true, "qr_bar_code_enabled": true, "callback_api_enabled": true, "import_once_catalog_enabled": true, "import_once_description_enabled": true, "import_once_image_enabled": true, "import_once_labels_enabled": true, "districts_settings": [ { "id": 0, "terminal": "terminal1", "delivery": "delivery1" } ], "pickups_settings": [ { "id": 0, "terminal": "terminal1" } ] }, "list": [ { "id": 1, "name": "FrontPad", "fields": [ { "encrypted": true, "name": "api_key", "type": "switch", "values": [] } ], "districts": true, "pickups": true, "site": "https://frontpad.ru/", "wiki": "https://wiki.foodsoul.pro/i/40", "import_mode": "no", "webhook_link_enabled": true, "webhook_setup_enabled": true, "system_name": "front_pad", "webhook": "https://ru.foodsoul.test/webhook/automation/front_pad/?token=f20138c54eaaad6c00ac77d27b2f4cb4" } ] } }