Obter configurações de integração com o sistema de automação

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 8922

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobjectobrigatório

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

settingsobject

chain_idintegerobrigatório

Exemplo: 1

automation_idintegerobrigatório

Exemplo: 1

automation_enabledbooleanobrigatório

Exemplo: true

automation_error_notifications_enabledbooleanobrigatório

Exemplo: true

price_smsstringobrigatório

Exemplo: 3.5

tokenstringobrigatório

Exemplo: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringobrigatório

Exemplo: FS

phone_clean_enabledbooleanobrigatório

Exemplo: true

phone_plus_delete_enabledbooleanobrigatório

Exemplo: true

phone_space_delete_enabledbooleanobrigatório

Exemplo: true

qr_bar_code_enabledbooleanobrigatório

Exemplo: true

callback_api_enabledbooleanobrigatório

Exemplo: true

import_once_catalog_enabledbooleanobrigatório

Exemplo: true

import_once_description_enabledbooleanobrigatório

Exemplo: true

import_once_image_enabledbooleanobrigatório

Exemplo: true

import_once_labels_enabledbooleanobrigatório

Exemplo: true

districts_settingsarray of object

idintegerobrigatório

Para as configurações padrão, id é igual a 0

Exemplo: 0

terminalstring

Chave do campo de formulário district_data_${district_id}_terminal

Exemplo: terminal1

deliverystring

Chave do campo de formulário district_data_${district_id}_delivery

Exemplo: delivery1

pickups_settingsarray of object

idintegerobrigatório

Para as configurações padrão, id é igual a 0

Exemplo: 0

terminalstring

Chave do campo de formulário pickup_data_${pickup_id}_terminal

Exemplo: terminal1

listarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: FrontPad

fieldsarray of object

encryptedbooleanobrigatório

Campo criptografado; use um campo do tipo "senha" para entrada

Exemplo: true

namestringobrigatório

Exemplo: api_key

valueoneOf

Uma das opções

string

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

Exemplo: secret

typestring

Valores:switchradiocheckboxselectfile

Exemplo: switch

valuesarray of string

districtsbooleanobrigatório

Exemplo: true

pickupsbooleanobrigatório

Exemplo: true

sitestring

Exemplo: https://frontpad.ru/

wikistring

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

import_modestringobrigatório

Valores:nomanualautomatic

Exemplo: no

webhook_link_enabledbooleanobrigatório

Exemplo: true

webhook_setup_enabledbooleanobrigatório

Exemplo: true

system_namestring

Exemplo: front_pad

webhookstring

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