Получить настройки интеграции с системой автоматизации

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' => 'ru', '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": "ru", "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": "ru", "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" } ] } }