Ottenere le impostazioni di integrazione con il sistema di automazione

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 8922

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobjectobbligatorio

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

settingsobject

chain_idintegerobbligatorio

Esempio: 1

automation_idintegerobbligatorio

Esempio: 1

automation_enabledbooleanobbligatorio

Esempio: true

automation_error_notifications_enabledbooleanobbligatorio

Esempio: true

price_smsstringobbligatorio

Esempio: 3.5

tokenstringobbligatorio

Esempio: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringobbligatorio

Esempio: FS

phone_clean_enabledbooleanobbligatorio

Esempio: true

phone_plus_delete_enabledbooleanobbligatorio

Esempio: true

phone_space_delete_enabledbooleanobbligatorio

Esempio: true

qr_bar_code_enabledbooleanobbligatorio

Esempio: true

callback_api_enabledbooleanobbligatorio

Esempio: true

import_once_catalog_enabledbooleanobbligatorio

Esempio: true

import_once_description_enabledbooleanobbligatorio

Esempio: true

import_once_image_enabledbooleanobbligatorio

Esempio: true

import_once_labels_enabledbooleanobbligatorio

Esempio: true

districts_settingsarray of object

idintegerobbligatorio

Per le impostazioni predefinite, id è uguale a 0

Esempio: 0

terminalstring

Chiave del campo modulo district_data_${district_id}_terminal

Esempio: terminal1

deliverystring

Chiave del campo del modulo district_data_${district_id}_delivery

Esempio: delivery1

pickups_settingsarray of object

idintegerobbligatorio

Per le impostazioni predefinite, id è uguale a 0

Esempio: 0

terminalstring

Chiave del campo del modulo pickup_data_${pickup_id}_terminal

Esempio: terminal1

listarray of object

idintegerobbligatorio

Esempio: 1

namestringobbligatorio

Esempio: FrontPad

fieldsarray of object

encryptedbooleanobbligatorio

Campo crittografato; per l'inserimento utilizzare un campo di tipo "password"

Esempio: true

namestringobbligatorio

Esempio: api_key

valueoneOf

Una delle opzioni

string

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

Esempio: secret

typestring

Valori:switchradiocheckboxselectfile

Esempio: switch

valuesarray of string

districtsbooleanobbligatorio

Esempio: true

pickupsbooleanobbligatorio

Esempio: true

sitestring

Esempio: https://frontpad.ru/

wikistring

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

import_modestringobbligatorio

Valori:nomanualautomatic

Esempio: no

webhook_link_enabledbooleanobbligatorio

Esempio: true

webhook_setup_enabledbooleanobbligatorio

Esempio: true

system_namestring

Esempio: front_pad

webhookstring

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