Získat nastavení integrace se systémem automatizace

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 8922

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobjectpovinné

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

settingsobject

chain_idintegerpovinné

Příklad: 1

automation_idintegerpovinné

Příklad: 1

automation_enabledbooleanpovinné

Příklad: true

automation_error_notifications_enabledbooleanpovinné

Příklad: true

price_smsstringpovinné

Příklad: 3.5

tokenstringpovinné

Příklad: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringpovinné

Příklad: FS

phone_clean_enabledbooleanpovinné

Příklad: true

phone_plus_delete_enabledbooleanpovinné

Příklad: true

phone_space_delete_enabledbooleanpovinné

Příklad: true

qr_bar_code_enabledbooleanpovinné

Příklad: true

callback_api_enabledbooleanpovinné

Příklad: true

import_once_catalog_enabledbooleanpovinné

Příklad: true

import_once_description_enabledbooleanpovinné

Příklad: true

import_once_image_enabledbooleanpovinné

Příklad: true

import_once_labels_enabledbooleanpovinné

Příklad: true

districts_settingsarray of object

idintegerpovinné

U výchozího nastavení je id rovno 0

Příklad: 0

terminalstring

Klíč pole formuláře district_data_${district_id}_terminal

Příklad: terminal1

deliverystring

Klíč pole formuláře district_data_${district_id}_delivery

Příklad: delivery1

pickups_settingsarray of object

idintegerpovinné

U výchozího nastavení je id rovno 0

Příklad: 0

terminalstring

Klíč pole formuláře pickup_data_${pickup_id}_terminal

Příklad: terminal1

listarray of object

idintegerpovinné

Příklad: 1

namestringpovinné

Příklad: FrontPad

fieldsarray of object

encryptedbooleanpovinné

Šifrované pole; pro zadání použijte pole typu „heslo“

Příklad: true

namestringpovinné

Příklad: api_key

valueoneOf

Jedna z možností

string

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

Příklad: secret

typestring

Hodnoty:switchradiocheckboxselectfile

Příklad: switch

valuesarray of string

districtsbooleanpovinné

Příklad: true

pickupsbooleanpovinné

Příklad: true

sitestring

Příklad: https://frontpad.ru/

wikistring

Příklad: https://wiki.foodsoul.pro/i/40

import_modestringpovinné

Hodnoty:nomanualautomatic

Příklad: no

webhook_link_enabledbooleanpovinné

Příklad: true

webhook_setup_enabledbooleanpovinné

Příklad: true

system_namestring

Příklad: front_pad

webhookstring

Příklad: https://ru.foodsoul.test/webhook/automation/front_pad/?token=f20138c54eaaad6c00ac77d27b2f4cb4

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/integration_automations', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'cs', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/integration_automations", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "cs", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/integration_automations", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "cs", "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" } ] } }