Метод используется для получения настроек кастомизации Панели управления Клиента (см. ).
GET {reseller_domain}/internal_api/customization_setting
В этой статье:
Авторизация
Авторизация не требуется.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
Модель ответа
Пример запроса
Bash
curl --location --request GET 'https://test.activeplatform.com/internal_api/customization_setting' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en'
Пример ответа
JSON
{
"data": {
"id": "1",
"type": "customization_setting",
"attributes": {
"global_settings": {
"title": "ActivePlatform",
"background_image": "https://storage.test.activeplatform.com/public/images/general_customization_setting/background_image/344/3297593.jpg",
"show_copyright": true,
"primary_color": "#3B9DDE",
"header": {
"sections": [
"main",
"orders",
"quotes",
"billing",
"catalog",
"payments",
"analytics",
"subscriptions",
"balance_statement",
"closing_documents",
"guaranteed_payments"
],
"navigation_menu_display": "inline",
"content": {
"links": []
}
}
},
"footer": {
"content": {
"links": [
{
"url": "https://example.com",
"name": "Link-1",
"priority": 0
},
{
"url": "https://example.org",
"name": "Link-2",
"priority": 0
},
{
"url": "https://example.net",
"name": "Link-3",
"priority": 0
}
]
},
"contacts": {
"address": "A-Wing-614, Kanakia Wallstreet",
"email": "mail@example.com",
"phone": "+1-234-555-6789"
},
"copyright": "© 2024 Reseller",
"socials": {
"facebook": "https://www.facebook.com/",
"instagram": "https://www.instagram.com/",
"linkedin": "https://www.linkedin.com/",
"youtube": "https://www.youtube.com/"
}
},
"logo_settings": {
"main_logotype_ccp": "https://storage.test.activeplatform.com/public/images/system_setting/logo/1/subs.png",
"inverted_logo": "https://storage.test.activeplatform.com/public/images/system_setting/inverted_logo/1/logo_dark.png",
"short_logo": "https://storage.test.activeplatform.com/public/images/system_setting/short_logo/1/logo_short.png",
"mobile_logo": "https://storage.test.activeplatform.com/public/images/system_setting/short_logo/1/logo_mob.png",
"stamp": null,
"favicon": "https://storage.test.activeplatform.com/public/images/system_setting/favicon/1/favicon.png"
},
"pages": {
"signin": {
"content": {
"welcome_text": "Welcome"
}
},
"signup": {
"content": {
"welcome_text": "Welcome"
}
},
"billing": {
"widgets": [
"balance",
"current_consumption",
"expected_amount_payments"
]
},
"main": {
"content": {
"widgets": [
"balance",
"subscriptions_payments_filters",
"catalog",
"currency_rate",
"expenses",
"help",
"current_consumption",
"recommendations",
"stories"
],
"info_messages": [
{
"from": null,
"to": null,
"created_at": "2022-11-25T08:19:27+00:00",
"importance": "high",
"text": "Test notification #1"
},
{
"from": "2023-01-01",
"to": "2023-03-01",
"created_at": "2022-12-22T09:01:57+00:00",
"importance": "low",
"text": "Test notification #2"
}
],
"widget_help": [
{
"url": "https://docs.activeplatform.com",
"name": "RTFM",
"priority": 0
}
]
}
},
"support": {
"redirect_url": "",
"content": {
"introduction_text": "Intro section text",
"sections": [
{
"title": "Section 1",
"text": "Text of Section 1",
"image": "https://storage.test.activeplatform.com/public/images/support_customization_setting/1/content_setting/1664.png",
"priority": 0
}
],
"feedback_section": "Feedback section text"
}
}
},
"custom_layout": {
"billing_tab": {
"visible": true,
"name": null
}
},
"external_services": {
"captcha_settings": {
"use_captcha_service": true,
"site_key": "ABC123"
},
"google_tag_manager_settings": {
"use_google_tag_manager_service": true,
"tag_id": "GTM-ABC123"
},
"cookiebot_cpm_settings": {
"use_cookiebot_cpm_service": false,
"setting_id": null
}
}
}
},
"meta": {
"server_current_time": "2024-10-09T17:15:45.322089+0300"
}
}