Abrufen der Integrationseinstellungen mit dem Automatisierungssystem

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 8922

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobjecterforderlich

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

settingsobject

chain_idintegererforderlich

Beispiel: 1

automation_idintegererforderlich

Beispiel: 1

automation_enabledbooleanerforderlich

Beispiel: true

automation_error_notifications_enabledbooleanerforderlich

Beispiel: true

price_smsstringerforderlich

Beispiel: 3.5

tokenstringerforderlich

Beispiel: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringerforderlich

Beispiel: FS

phone_clean_enabledbooleanerforderlich

Beispiel: true

phone_plus_delete_enabledbooleanerforderlich

Beispiel: true

phone_space_delete_enabledbooleanerforderlich

Beispiel: true

qr_bar_code_enabledbooleanerforderlich

Beispiel: true

callback_api_enabledbooleanerforderlich

Beispiel: true

import_once_catalog_enabledbooleanerforderlich

Beispiel: true

import_once_description_enabledbooleanerforderlich

Beispiel: true

import_once_image_enabledbooleanerforderlich

Beispiel: true

import_once_labels_enabledbooleanerforderlich

Beispiel: true

districts_settingsarray of object

idintegererforderlich

Bei den Standardeinstellungen ist id gleich 0

Beispiel: 0

terminalstring

Schlüsselfeld des Formulars district_data_${district_id}_terminal

Beispiel: terminal1

deliverystring

Schlüssel des Formularfelds district_data_${district_id}_delivery

Beispiel: delivery1

pickups_settingsarray of object

idintegererforderlich

Im Standard sind die id-Werte auf 0 gesetzt

Beispiel: 0

terminalstring

Schlüssel des Formularfelds pickup_data_${pickup_id}_terminal

Beispiel: terminal1

listarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: FrontPad

fieldsarray of object

encryptedbooleanerforderlich

Verschlüsseltes Feld; verwenden Sie für die Eingabe ein Feld vom Typ „Passwort“

Beispiel: true

namestringerforderlich

Beispiel: api_key

valueoneOf

Eine der Optionen

string

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

Beispiel: secret

typestring

Werte:switchradiocheckboxselectfile

Beispiel: switch

valuesarray of string

districtsbooleanerforderlich

Beispiel: true

pickupsbooleanerforderlich

Beispiel: true

sitestring

Beispiel: https://frontpad.ru/

wikistring

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

import_modestringerforderlich

Werte:nomanualautomatic

Beispiel: no

webhook_link_enabledbooleanerforderlich

Beispiel: true

webhook_setup_enabledbooleanerforderlich

Beispiel: true

system_namestring

Beispiel: front_pad

webhookstring

Beispiel: 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' => 'de', '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": "de", "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": "de", "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" } ] } }