Метод используется для получения системных настроек реселлера (форматы дат и сумм, доступные языки и модели оплаты, принятие соглашений и др.).
GET {reseller_domain}/internal_api/reseller_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 |
Обязательный |
Доменное имя реселлера |
Модель ответа
|
Название |
Тип данных |
Описание |
||||||
|---|---|---|---|---|---|---|---|---|
|
data |
object |
Данные ответа |
||||||
|
|
id |
string |
ID настроек реселлера |
|||||
|
|
type |
string |
Тип данных |
|||||
|
|
attributes |
object |
Информация о настройках реселлера |
|||||
|
|
|
agreement_privacy_policy |
object |
Требования к принятию условий обработки персональных данных и политики конфиденциальности (см. Соглашения с клиентами в
) |
||||
|
|
|
|
enabled |
bool |
Признак Запрашивать согласие c условиями обработки персональных данных и политикой конфиденциальности |
|||
|
|
|
|
notice_url |
string |
Ссылка на условия обработки персональных данных |
|||
|
|
|
|
agreement_url |
string |
Ссылка на политику конфиденциальности |
|||
|
|
|
format_date |
string |
Формат дат — маска, которая используется для отображения дат (см. Формат дат в
) |
||||
|
|
|
format_currencies |
array of objects |
Список всех валют, доступных для реселлера, и формат их отображения (см.
) |
||||
|
|
|
|
|
iso_code |
string |
Код валюты — уникальный трехбуквенный алфавитный код валюты по ISO 4217 |
||
|
|
|
|
|
precision |
integer |
Точность — количество десятичных знаков для сумм в валюте |
||
|
|
|
|
|
unit |
string |
Единица — обозначение единицы валюты в платформе |
||
|
|
|
|
|
separator |
string |
Десятичный разделитель — разделитель целой и десятичной частей суммы в валюте: точка или запятая |
||
|
|
|
|
|
delimiter |
string |
Разделитель разрядов — разделитель разрядов целой части суммы валюты: пробел или запятая |
||
|
|
|
|
|
format |
string |
Формат — порядок отображения суммы в валюте и ее единиц, где %n — сумма в валюте, %u — единица валюты |
||
|
|
|
allow_client_work_without_balance |
bool |
Признак Разрешить клиенту работать без баланса (см.
) |
||||
|
|
|
allow_client_top_up_balance |
bool |
Признак Разрешить клиенту пополнять баланс (см.
) |
||||
|
|
|
allow_order_postpaid_subscription |
string |
Модель оплаты по умолчанию для новых клиентов — настройка Модель оплаты по умолчанию в правиле обслуживания с признаком Правило по умолчанию для новых клиентов (см. ):
|
||||
|
|
|
unite_payments_manually |
bool |
Признак Объединять платежи вручную (см.
) |
||||
|
|
|
catalog_url |
string |
Ссылка на онлайн-витрину — URL каталога услуг, которые доступны для заказа через Панель управления Клиента (см.
) |
||||
|
|
|
store_only_for_authorized_users |
bool |
Признак Только для авторизованных пользователей — определяет доступность каталога Панели управления Клиента для неавторизованных пользователей (см.
) |
||||
|
|
|
agreement_terms_conditions |
object |
Требования к принятию общих условий работы (см. Соглашения с клиентами в
) |
||||
|
|
|
|
enabled |
bool |
Признак Запрашивать согласие с общими условиями работы |
|||
|
|
|
|
agreement_url |
string |
Ссылка на соглашение с общими условиями работы |
|||
|
|
|
external_invoice_generation |
bool |
Признак Счета формируются внешней системой (см.
) |
||||
|
|
|
monitoring_consumption_anomalies |
bool |
Настройка Активировать мониторинг увеличения расходов (см.
) |
||||
|
|
|
languages |
object |
Языковые настройки (см. Настройка языков панели Клиента в
) |
||||
|
|
|
|
keys |
array |
Список ключей доступных языков |
|||
|
|
|
|
default_key |
string |
Ключ языка по умолчанию для новых пользователей |
|||
|
|
|
|
human_names |
array of objects |
Названия языков для отображения в меню переключения языков в Панели управления Клиента |
|||
|
|
|
|
|
key |
string |
Ключ языка |
||
|
|
|
|
|
value |
string |
Название языка на языке, указанном в |
||
|
|
|
validation_service_is_active |
bool |
Признак Активировать валидационный сервис (см.
) |
||||
|
|
|
default_payment_model |
string |
Настройка Разрешать работу клиента по постоплате (см. ):
|
||||
|
|
|
taxes_calculation_settings |
object |
Настройки расчета налогов (см.
) |
||||
|
|
|
|
tax_is_calculated_using |
object |
Настройка Налоги рассчитываются (см. ):
|
|||
|
|
|
|
taxes |
array of objects |
Список налогов |
|||
|
|
|
|
|
id |
integer |
ID налога |
||
|
|
|
|
|
name |
string |
Название налога |
||
|
|
|
|
|
rate |
number |
Ставка налога в процентах |
||
|
|
|
|
|
account_types |
array |
Список ключей типов клиента, для которых применяется налог |
||
|
|
|
first_postpaid_subscription |
string |
Значение настройки Разрешать работу клиента по постоплате (см. ):
|
||||
|
|
|
mfa_available_methods |
array of objects |
Список методов MFA, доступных для выбора и настройки пользователями (см. MFA) |
||||
|
|
|
|
key |
string |
Ключ метода MFA:
|
|||
|
|
|
|
name |
string |
Название метода MFA |
|||
|
|
|
user_mfa_mandatory_use |
bool |
Признак обязательности использования MFA для всех пользователей Панели управления Клиента (см.
) |
||||
|
|
|
user_mfa_trusted_devices_expire_in |
integer |
Число месяцев, в течение которых устройство, на котором пользователь клиента вошел в Панель управления Клиента, считается "доверенным", и второй шаг аутентификации пропускается. Минимальное значение: 0 — устройства не считаются "доверенными", второй шаг аутентификации отображается при каждом входе пользователя клиента в Панель управления Клиента (см.
) |
||||
|
|
|
users_sign_on_method |
string |
|
||||
|
meta |
object |
Дополнительная информация |
||||||
|
|
server_current_time |
string |
Текущие дата и время сервера |
|||||
Пример запроса
curl --location --request GET 'https://test.activeplatform.com/internal_api/reseller_setting' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en'
Пример ответа
{
"data": {
"id": "1",
"type": "reseller_setting",
"attributes": {
"agreement_privacy_policy": {
"enabled": true,
"notice_url": "https://example.com/privacy-notice",
"agreement_url": "https://example.com/privacy-policy"
},
"format_date": "%dd.%mm.%yyyy",
"format_currencies": [
{
"iso_code": "USD",
"precision": 2,
"unit": "$",
"separator": ".",
"delimiter": ",",
"format": "%u%n"
},
{
"iso_code": "EUR",
"precision": 2,
"unit": "€",
"separator": ".",
"delimiter": ",",
"format": "%n %u"
}
],
"allow_client_work_without_balance": false,
"allow_client_top_up_balance": true,
"allow_order_postpaid_subscription": "manually",
"unite_payments_manually": true,
"catalog_url": "",
"store_only_for_authorized_users": true,
"agreement_terms_conditions": {
"enabled": true,
"agreement_url": "https://www.example.com/tos"
},
"external_invoice_generation": false,
"monitoring_consumption_anomalies": true,
"languages": {
"keys": [
"en",
"pl",
"ru"
],
"default_key": "en",
"human_names": [
{
"key": "en",
"value": "English (English)"
},
{
"key": "pl",
"value": "Polish (Polski)"
},
{
"key": "ru",
"value": "Russian (Русский)"
}
]
},
"validation_service_is_active": false,
"default_payment_model": "prepay",
"taxes_calculation_settings": {
"tax_is_calculated_using": "gross_prices",
"taxes": [
{
"id": 1,
"name": "VAT",
"rate": 20,
"account_types": [
"business",
"personal"
]
},
{
"id": 2,
"name": "Local tax",
"rate": 5,
"account_types": [
"business",
"personal"
]
},
{
"id": 3,
"name": "Regional tax",
"rate": 2.5,
"account_types": [
"business",
"personal"
]
}
]
},
"first_postpaid_subscription": null,
"mfa_available_methods": [
{
"key": "authenticator",
"name": "Authenticator App"
}
],
"user_mfa_mandatory_use": true,
"user_mfa_trusted_devices_expire_in": 1,
"users_sign_on_method": "plain"
},
"meta": {
"server_current_time": "2023-06-30 T12:34:56.199973+0300"
}
}
}