Змінити налаштування мобільного застосунку

POST/api/crm/v2/mobile_apps_settings.updatev2

operationId: mobileAppsSettings.update

Зберігає налаштування мобільного додатку. Фонове зображення та логотипи завантажуються як multipart.

Авторизація

api-token + language + role

Параметри запиту

branch_idintegerобов’язковий

Приклад: 1

Тіло запиту `multipart/form-data`

object

Якщо auto_change вимкнено, обов’язково вказати theme_default, інакше — theme_day та theme_night

apps_noticestringобов’язковий

Приклад: Hello World

templatestringобов’язковий

Значення:side_menubottom_menu

mobile_apps_titlestringобов’язковий

Приклад: Pizza

mobile_apps_subtitlestring

Приклад: Pizza

mobile_apps_icon_namestringобов’язковий

Приклад: icon1

mobile_apps_keywordsstringобов’язковий

Приклад: delivery,online,order,pizza,sushi,rolls,snacks,salads,sets

mobile_apps_short_descriptionstringобов’язковий

Приклад: We are here to make your day better

mobile_apps_full_descriptionstringобов’язковий

Приклад: Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks

update_metadataboolean

Приклад: true

update_screenshotsboolean

Приклад: true

ios_force_update_enabledboolean

Приклад: true

marketer_reviewedboolean

Приклад: true

auto_changeboolean

Приклад: true

designer_reviewedboolean

Приклад: true

special_offers_separate_sectionboolean

Приклад: true

special_offers_title_in_catalogboolean

Приклад: true

bottom_menu_icons_and_titles_boldboolean

Тільки якщо template = bottom_menu

Приклад: true

bottom_menu_titles_showboolean

Тільки якщо template = bottom_menu

Приклад: true

side_menu_icons_and_titles_boldboolean

Тільки якщо template = side_menu

Приклад: true

side_menu_background_colorstring

Тільки якщо template = side_menu

Приклад: C51162

side_menu_icons_and_titles_colorstring

Тільки якщо template = side_menu

Приклад: C51162

catalog_items_in_two_columnsboolean

Приклад: true

catalog_horizontal_categoriesboolean

Приклад: true

catalog_items_animation_on_tap_enabledboolean

Відтворювати анімацію зображень товарів лише після натискання на них

Приклад: true

special_offers_animation_on_tap_enabledboolean

Відтворювати анімацію зображень акцій лише після натискання на них

Приклад: true

theme_defaultstring (ThemeDefault)

Можливі значення: light, bright, blue, dark

Значення:lightbrightbluedark

Приклад: light

theme_daystring

Значення:lightbright

Приклад: light

theme_nightstring

Значення:bluedark

Приклад: dark

main_colorstringобов’язковий

Приклад: C51162

catalog_items_image_ratiostringобов’язковий

Значення:5:230:191:14:316:9

Приклад: 5:2

catalog_items_max_rows_descriptionintegerобов’язковий

Приклад: 3

background_image_linkstring

Тільки якщо template = side_menu: URL вибраного зображення з галереї

Приклад: https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg

background_imagestring · binary

Тільки якщо template = side_menu; розмір від 1 до 1536 × від 1 до 2048 пікселів

radius_blurinteger

Тільки якщо template = side_menu

Приклад: 0

logostring · binary

800 × 300 пікселів

ios_iconstring · binary

1024 × 1024 пікселів

watch_iconstring · binary

1024 × 1024 пікселів

android_iconstring · binary

1024 × 1024 пікселів

google_play_metadatastring · binary

1024 × 500 пікселів

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

descriptionstring

Приклад: Successfully saved

logostring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/themes/mobile_apps/87c8980728da83d80e4f8a5f7dfa67c4.png?v1748430033

google_play_metadatastring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/meta_data/google_play.png?v1748430936

ios_iconstring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/ios.png?v1748430936

watch_iconstring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/watch.png?v1748430936

android_iconstring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/android.png?v1748430936

curl -X POST 'https://foodsoul.ru/api/crm/v2/mobile_apps_settings.update?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: uk' \
  -H 'role: partner' \
  -F 'apps_notice=Hello World' \
  -F 'template=side_menu' \
  -F 'mobile_apps_title=Pizza' \
  -F 'mobile_apps_subtitle=Pizza' \
  -F 'mobile_apps_icon_name=icon1' \
  -F 'mobile_apps_keywords=delivery,online,order,pizza,sushi,rolls,snacks,salads,sets' \
  -F 'mobile_apps_short_description=We are here to make your day better' \
  -F 'mobile_apps_full_description=Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks' \
  -F 'update_metadata=true' \
  -F 'update_screenshots=true' \
  -F 'ios_force_update_enabled=true' \
  -F 'marketer_reviewed=true' \
  -F 'auto_change=true' \
  -F 'designer_reviewed=true' \
  -F 'special_offers_separate_section=true' \
  -F 'special_offers_title_in_catalog=true' \
  -F 'bottom_menu_icons_and_titles_bold=true' \
  -F 'bottom_menu_titles_show=true' \
  -F 'side_menu_icons_and_titles_bold=true' \
  -F 'side_menu_background_color=C51162' \
  -F 'side_menu_icons_and_titles_color=C51162' \
  -F 'catalog_items_in_two_columns=true' \
  -F 'catalog_horizontal_categories=true' \
  -F 'catalog_items_animation_on_tap_enabled=true' \
  -F 'special_offers_animation_on_tap_enabled=true' \
  -F 'theme_default=light' \
  -F 'theme_day=light' \
  -F 'theme_night=dark' \
  -F 'main_color=C51162' \
  -F 'catalog_items_image_ratio=5:2' \
  -F 'catalog_items_max_rows_description=3' \
  -F 'background_image_link=https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg' \
  -F 'background_image=@file.jpg' \
  -F 'radius_blur=0' \
  -F 'logo=@file.jpg' \
  -F 'ios_icon=@file.jpg' \
  -F 'watch_icon=@file.jpg' \
  -F 'android_icon=@file.jpg' \
  -F 'google_play_metadata=@file.jpg'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/mobile_apps_settings.update?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'uk',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'apps_notice',
            'contents' => 'Hello World',
        ],
        [
            'name' => 'template',
            'contents' => 'side_menu',
        ],
        [
            'name' => 'mobile_apps_title',
            'contents' => 'Pizza',
        ],
        [
            'name' => 'mobile_apps_subtitle',
            'contents' => 'Pizza',
        ],
        [
            'name' => 'mobile_apps_icon_name',
            'contents' => 'icon1',
        ],
        [
            'name' => 'mobile_apps_keywords',
            'contents' => 'delivery,online,order,pizza,sushi,rolls,snacks,salads,sets',
        ],
        [
            'name' => 'mobile_apps_short_description',
            'contents' => 'We are here to make your day better',
        ],
        [
            'name' => 'mobile_apps_full_description',
            'contents' => 'Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks',
        ],
        [
            'name' => 'update_metadata',
            'contents' => 'true',
        ],
        [
            'name' => 'update_screenshots',
            'contents' => 'true',
        ],
        [
            'name' => 'ios_force_update_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'marketer_reviewed',
            'contents' => 'true',
        ],
        [
            'name' => 'auto_change',
            'contents' => 'true',
        ],
        [
            'name' => 'designer_reviewed',
            'contents' => 'true',
        ],
        [
            'name' => 'special_offers_separate_section',
            'contents' => 'true',
        ],
        [
            'name' => 'special_offers_title_in_catalog',
            'contents' => 'true',
        ],
        [
            'name' => 'bottom_menu_icons_and_titles_bold',
            'contents' => 'true',
        ],
        [
            'name' => 'bottom_menu_titles_show',
            'contents' => 'true',
        ],
        [
            'name' => 'side_menu_icons_and_titles_bold',
            'contents' => 'true',
        ],
        [
            'name' => 'side_menu_background_color',
            'contents' => 'C51162',
        ],
        [
            'name' => 'side_menu_icons_and_titles_color',
            'contents' => 'C51162',
        ],
        [
            'name' => 'catalog_items_in_two_columns',
            'contents' => 'true',
        ],
        [
            'name' => 'catalog_horizontal_categories',
            'contents' => 'true',
        ],
        [
            'name' => 'catalog_items_animation_on_tap_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'special_offers_animation_on_tap_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'theme_default',
            'contents' => 'light',
        ],
        [
            'name' => 'theme_day',
            'contents' => 'light',
        ],
        [
            'name' => 'theme_night',
            'contents' => 'dark',
        ],
        [
            'name' => 'main_color',
            'contents' => 'C51162',
        ],
        [
            'name' => 'catalog_items_image_ratio',
            'contents' => '5:2',
        ],
        [
            'name' => 'catalog_items_max_rows_description',
            'contents' => '3',
        ],
        [
            'name' => 'background_image_link',
            'contents' => 'https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg',
        ],
        [
            'name' => 'background_image',
            'contents' => '<file>',
        ],
        [
            'name' => 'radius_blur',
            'contents' => '0',
        ],
        [
            'name' => 'logo',
            'contents' => '<file>',
        ],
        [
            'name' => 'ios_icon',
            'contents' => '<file>',
        ],
        [
            'name' => 'watch_icon',
            'contents' => '<file>',
        ],
        [
            'name' => 'android_icon',
            'contents' => '<file>',
        ],
        [
            'name' => 'google_play_metadata',
            'contents' => '<file>',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("apps_notice", "Hello World")
body.append("template", "side_menu")
body.append("mobile_apps_title", "Pizza")
body.append("mobile_apps_subtitle", "Pizza")
body.append("mobile_apps_icon_name", "icon1")
body.append("mobile_apps_keywords", "delivery,online,order,pizza,sushi,rolls,snacks,salads,sets")
body.append("mobile_apps_short_description", "We are here to make your day better")
body.append("mobile_apps_full_description", "Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks")
body.append("update_metadata", "true")
body.append("update_screenshots", "true")
body.append("ios_force_update_enabled", "true")
body.append("marketer_reviewed", "true")
body.append("auto_change", "true")
body.append("designer_reviewed", "true")
body.append("special_offers_separate_section", "true")
body.append("special_offers_title_in_catalog", "true")
body.append("bottom_menu_icons_and_titles_bold", "true")
body.append("bottom_menu_titles_show", "true")
body.append("side_menu_icons_and_titles_bold", "true")
body.append("side_menu_background_color", "C51162")
body.append("side_menu_icons_and_titles_color", "C51162")
body.append("catalog_items_in_two_columns", "true")
body.append("catalog_horizontal_categories", "true")
body.append("catalog_items_animation_on_tap_enabled", "true")
body.append("special_offers_animation_on_tap_enabled", "true")
body.append("theme_default", "light")
body.append("theme_day", "light")
body.append("theme_night", "dark")
body.append("main_color", "C51162")
body.append("catalog_items_image_ratio", "5:2")
body.append("catalog_items_max_rows_description", "3")
body.append("background_image_link", "https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg")
body.append("background_image", "<file>")
body.append("radius_blur", "0")
body.append("logo", "<file>")
body.append("ios_icon", "<file>")
body.append("watch_icon", "<file>")
body.append("android_icon", "<file>")
body.append("google_play_metadata", "<file>")

const response = await fetch("https://foodsoul.ru/api/crm/v2/mobile_apps_settings.update?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/mobile_apps_settings.update?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
    },
    files={
        "apps_notice": [
            None,
            "Hello World",
        ],
        "template": [
            None,
            "side_menu",
        ],
        "mobile_apps_title": [
            None,
            "Pizza",
        ],
        "mobile_apps_subtitle": [
            None,
            "Pizza",
        ],
        "mobile_apps_icon_name": [
            None,
            "icon1",
        ],
        "mobile_apps_keywords": [
            None,
            "delivery,online,order,pizza,sushi,rolls,snacks,salads,sets",
        ],
        "mobile_apps_short_description": [
            None,
            "We are here to make your day better",
        ],
        "mobile_apps_full_description": [
            None,
            "Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks",
        ],
        "update_metadata": [
            None,
            "true",
        ],
        "update_screenshots": [
            None,
            "true",
        ],
        "ios_force_update_enabled": [
            None,
            "true",
        ],
        "marketer_reviewed": [
            None,
            "true",
        ],
        "auto_change": [
            None,
            "true",
        ],
        "designer_reviewed": [
            None,
            "true",
        ],
        "special_offers_separate_section": [
            None,
            "true",
        ],
        "special_offers_title_in_catalog": [
            None,
            "true",
        ],
        "bottom_menu_icons_and_titles_bold": [
            None,
            "true",
        ],
        "bottom_menu_titles_show": [
            None,
            "true",
        ],
        "side_menu_icons_and_titles_bold": [
            None,
            "true",
        ],
        "side_menu_background_color": [
            None,
            "C51162",
        ],
        "side_menu_icons_and_titles_color": [
            None,
            "C51162",
        ],
        "catalog_items_in_two_columns": [
            None,
            "true",
        ],
        "catalog_horizontal_categories": [
            None,
            "true",
        ],
        "catalog_items_animation_on_tap_enabled": [
            None,
            "true",
        ],
        "special_offers_animation_on_tap_enabled": [
            None,
            "true",
        ],
        "theme_default": [
            None,
            "light",
        ],
        "theme_day": [
            None,
            "light",
        ],
        "theme_night": [
            None,
            "dark",
        ],
        "main_color": [
            None,
            "C51162",
        ],
        "catalog_items_image_ratio": [
            None,
            "5:2",
        ],
        "catalog_items_max_rows_description": [
            None,
            "3",
        ],
        "background_image_link": [
            None,
            "https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg",
        ],
        "background_image": [
            None,
            "<file>",
        ],
        "radius_blur": [
            None,
            "0",
        ],
        "logo": [
            None,
            "<file>",
        ],
        "ios_icon": [
            None,
            "<file>",
        ],
        "watch_icon": [
            None,
            "<file>",
        ],
        "android_icon": [
            None,
            "<file>",
        ],
        "google_play_metadata": [
            None,
            "<file>",
        ],
    },
)
data = response.json()

Відповідь 200

{
  "status": "success",
  "data": {
    "description": "Successfully saved",
    "logo": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/themes/mobile_apps/87c8980728da83d80e4f8a5f7dfa67c4.png?v1748430033",
    "google_play_metadata": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/meta_data/google_play.png?v1748430936",
    "ios_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/ios.png?v1748430936",
    "watch_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/watch.png?v1748430936",
    "android_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/android.png?v1748430936"
  }
}

Запити надсилаються на foodsoul.ru — це хост цього порталу, інший обрати неможливо.

Змінити налаштування мобільного застосунку

Авторизація

Параметри запиту

Тіло запиту multipart/form-data

Відповіді

Тіло запиту `multipart/form-data`