Получение списка курсов валют

Метод Get list of currency rates используется для получения списка курсов валют, установленных для валюты реселлера на уровне текущего реселлера или любого из его нижестоящих реселлеров.

Курсы валют задаются на уровне корневого реселлера и автоматически применяются для всех реселлеров на всех нижестоящих уровнях, где не был вручную задан свой курс. По умолчанию все курсы валют установлены равными 1. Подробнее см. Управление курсами валют.

Получение списка курсов валют реселлера по API доступно только сотрудникам с ролью Системный администратор (см. Роли сотрудников).

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/currency_rates

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

Модель ответа

Название				Тип данных	Описание
data				object	Данные ответа
	id			string	ID валюты реселлера, для которой запрашиваются курсы валют
	type			string	Тип данных
	attributes			object	Параметры курсов валют для валюты реселлера
		created_at		string	Дата и время создания курсов валют для валюты реселлера
		updated_at		string	Дата и время последнего обновления курсов валют для валюты реселлера
		reseller_currency_iso_code		string	Код валюты реселлера по ISO 4217:2008
		reseller_currency_unit		string	Обозначение единицы валюты реселлера в платформе
		rates		array of objects	Список установленных курсов валют
			iso_code	string	Код валюты по ISO 4217:2008
			unit	string	Обозначение единицы валюты в платформе
			quantity	integer	Номинал (количество единиц) валюты, для которого установлен курс
			rate	string	Текущий курс валюты для указанного `quantity`
			show_for_client	bool	Признак отображения курса валюты в Панели управления Клиента (см. Стандартная структура страниц): true — курс валюты отображается в Панели управления Клиента. false — курс валюты не отображается в Панели управления Клиента.

Пример запроса

GET /api/v3/resellers/1/currency_rates
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
    "data": {
        "id": "4",
        "type": "currency_rates",
        "attributes": {
            "created_at": "2016-08-25T09:26:12.491+03:00",
            "updated_at": "2021-06-21T11:22:17.167+03:00",
            "reseller_currency_iso_code": "RUB",
            "reseller_currency_unit": "руб.",
            "rates": [
                {
                    "iso_code": "BYN",
                    "unit": "бел. руб.",
                    "quantity": 4,
                    "rate": "6.0",
                    "show_for_client": true
                },
                {
                    "iso_code": "USD",
                    "unit": "$",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "EUR",
                    "unit": "€",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": true
                },
                {
                    "iso_code": "UAH",
                    "unit": "грн.",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "GEL",
                    "unit": "лари.",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "AMD",
                    "unit": "драм.",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "UZS",
                    "unit": "сум.",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": true
                },
                {
                    "iso_code": "AZN",
                    "unit": "ман.",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "KZT",
                    "unit": "тг.",
                    "quantity": 1,
                    "rate": "67.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "VND",
                    "unit": "₫",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": false
                },
                {
                    "iso_code": "BRL",
                    "unit": "R$",
                    "quantity": 1,
                    "rate": "1.0",
                    "show_for_client": true
                }
            ]
        }
    }
}