Obtener la configuración de integración con el sistema de automatización

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 8922

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobjectobligatorio

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

settingsobject

chain_idintegerobligatorio

Ejemplo: 1

automation_idintegerobligatorio

Ejemplo: 1

automation_enabledbooleanobligatorio

Ejemplo: true

automation_error_notifications_enabledbooleanobligatorio

Ejemplo: true

price_smsstringobligatorio

Ejemplo: 3.5

tokenstringobligatorio

Ejemplo: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringobligatorio

Ejemplo: FS

phone_clean_enabledbooleanobligatorio

Ejemplo: true

phone_plus_delete_enabledbooleanobligatorio

Ejemplo: true

phone_space_delete_enabledbooleanobligatorio

Ejemplo: true

qr_bar_code_enabledbooleanobligatorio

Ejemplo: true

callback_api_enabledbooleanobligatorio

Ejemplo: true

import_once_catalog_enabledbooleanobligatorio

Ejemplo: true

import_once_description_enabledbooleanobligatorio

Ejemplo: true

import_once_image_enabledbooleanobligatorio

Ejemplo: true

import_once_labels_enabledbooleanobligatorio

Ejemplo: true

districts_settingsarray of object

idintegerobligatorio

En la configuración predeterminada, id es igual a 0

Ejemplo: 0

terminalstring

Clave del campo de formulario district_data_${district_id}_terminal

Ejemplo: terminal1

deliverystring

Clave del campo de formulario district_data_${district_id}_delivery

Ejemplo: delivery1

pickups_settingsarray of object

idintegerobligatorio

En la configuración predeterminada, id es igual a 0

Ejemplo: 0

terminalstring

Clave del campo de formulario pickup_data_${pickup_id}_terminal

Ejemplo: terminal1

listarray of object

idintegerobligatorio

Ejemplo: 1

namestringobligatorio

Ejemplo: FrontPad

fieldsarray of object

encryptedbooleanobligatorio

Campo cifrado; para la entrada, utilice un campo de tipo "contraseña"

Ejemplo: true

namestringobligatorio

Ejemplo: api_key

valueoneOf

Una de las opciones

string

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

Ejemplo: secret

typestring

Valores:switchradiocheckboxselectfile

Ejemplo: switch

valuesarray of string

districtsbooleanobligatorio

Ejemplo: true

pickupsbooleanobligatorio

Ejemplo: true

sitestring

Ejemplo: https://frontpad.ru/

wikistring

Ejemplo: https://wiki.foodsoul.pro/i/40

import_modestringobligatorio

Valores:nomanualautomatic

Ejemplo: no

webhook_link_enabledbooleanobligatorio

Ejemplo: true

webhook_setup_enabledbooleanobligatorio

Ejemplo: true

system_namestring

Ejemplo: front_pad

webhookstring

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