Pobierz ustawienia integracji z systemem automatyzacji

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 8922

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobjectwymagane

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject

chain_idintegerwymagane

Przykład: 1

automation_idintegerwymagane

Przykład: 1

automation_enabledbooleanwymagane

Przykład: true

automation_error_notifications_enabledbooleanwymagane

Przykład: true

price_smsstringwymagane

Przykład: 3.5

tokenstringwymagane

Przykład: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringwymagane

Przykład: FS

phone_clean_enabledbooleanwymagane

Przykład: true

phone_plus_delete_enabledbooleanwymagane

Przykład: true

phone_space_delete_enabledbooleanwymagane

Przykład: true

qr_bar_code_enabledbooleanwymagane

Przykład: true

callback_api_enabledbooleanwymagane

Przykład: true

import_once_catalog_enabledbooleanwymagane

Przykład: true

import_once_description_enabledbooleanwymagane

Przykład: true

import_once_image_enabledbooleanwymagane

Przykład: true

import_once_labels_enabledbooleanwymagane

Przykład: true

districts_settingsarray of object

idintegerwymagane

Dla ustawień domyślnych id jest równe 0

Przykład: 0

terminalstring

Klucz pola formularza district_data_${district_id}_terminal

Przykład: terminal1

deliverystring

Klucz pola formularza district_data_${district_id}_delivery

Przykład: delivery1

pickups_settingsarray of object

idintegerwymagane

Domyślnie id jest równe 0

Przykład: 0

terminalstring

Klucz pola formularza pickup_data_${pickup_id}_terminal

Przykład: terminal1

listarray of object

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: FrontPad

fieldsarray of object

encryptedbooleanwymagane

Zaszyfrowane pole; do wprowadzania użyj pola typu „hasło”

Przykład: true

namestringwymagane

Przykład: api_key

valueoneOf

Jeden z wariantów

string

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

Przykład: secret

typestring

Wartości:switchradiocheckboxselectfile

Przykład: switch

valuesarray of string

districtsbooleanwymagane

Przykład: true

pickupsbooleanwymagane

Przykład: true

sitestring

Przykład: https://frontpad.ru/

wikistring

Przykład: https://wiki.foodsoul.pro/i/40

import_modestringwymagane

Wartości:nomanualautomatic

Przykład: no

webhook_link_enabledbooleanwymagane

Przykład: true

webhook_setup_enabledbooleanwymagane

Przykład: true

system_namestring

Przykład: front_pad

webhookstring

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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" } ] } }