Obtenir les paramètres d'intégration avec le système d'automatisation

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 8922

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobjectobligatoire

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

settingsobject

chain_idintegerobligatoire

Exemple: 1

automation_idintegerobligatoire

Exemple: 1

automation_enabledbooleanobligatoire

Exemple: true

automation_error_notifications_enabledbooleanobligatoire

Exemple: true

price_smsstringobligatoire

Exemple: 3.5

tokenstringobligatoire

Exemple: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringobligatoire

Exemple: FS

phone_clean_enabledbooleanobligatoire

Exemple: true

phone_plus_delete_enabledbooleanobligatoire

Exemple: true

phone_space_delete_enabledbooleanobligatoire

Exemple: true

qr_bar_code_enabledbooleanobligatoire

Exemple: true

callback_api_enabledbooleanobligatoire

Exemple: true

import_once_catalog_enabledbooleanobligatoire

Exemple: true

import_once_description_enabledbooleanobligatoire

Exemple: true

import_once_image_enabledbooleanobligatoire

Exemple: true

import_once_labels_enabledbooleanobligatoire

Exemple: true

districts_settingsarray of object

idintegerobligatoire

Pour les paramètres par défaut, id est égal à 0

Exemple: 0

terminalstring

Clé du champ de formulaire district_data_${district_id}_terminal

Exemple: terminal1

deliverystring

Clé du champ de formulaire district_data_${district_id}_delivery

Exemple: delivery1

pickups_settingsarray of object

idintegerobligatoire

Pour les paramètres par défaut, id est égal à 0

Exemple: 0

terminalstring

Clé du champ de formulaire pickup_data_${pickup_id}_terminal

Exemple: terminal1

listarray of object

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: FrontPad

fieldsarray of object

encryptedbooleanobligatoire

Champ chiffré ; utilisez un champ de type « mot de passe » pour la saisie

Exemple: true

namestringobligatoire

Exemple: api_key

valueoneOf

L'une des options

string

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

Exemple: secret

typestring

Valeurs:switchradiocheckboxselectfile

Exemple: switch

valuesarray of string

districtsbooleanobligatoire

Exemple: true

pickupsbooleanobligatoire

Exemple: true

sitestring

Exemple: https://frontpad.ru/

wikistring

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

import_modestringobligatoire

Valeurs:nomanualautomatic

Exemple: no

webhook_link_enabledbooleanobligatoire

Exemple: true

webhook_setup_enabledbooleanobligatoire

Exemple: true

system_namestring

Exemple: front_pad

webhookstring

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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" } ] } }