Руководство прикладного разработчика Platform V Exchange Rates#

Термины и определения#

В таблице приведены основные термины, аббревиатуры и сокращения:

Термин/Аббревиатура

Определение

API

Application Programming Interface — программный интерфейс приложения

ERNP

Exchange Rate Natural Person — курс валюты для физических лиц

PMR

Precious Metal Rate — курс драгоценного металла

АС

Автоматизированная система

ВСП

Внутреннее структурное подразделение

ОМС

Обезличенные металлические счета

ФЛ

Физические лица

ЦБ

Центральный банк Российской Федерации

ЮЛ

Юридические лица

Подключение и конфигурирование#

Для подключения продукта используется публичное API.

С описанием API можно ознакомиться в документе Описание API продукта Platform V Exchange Rates.

Миграция на текущую версию#

Миграция на текущую версию представляет собой ее подключение в соответствии с разделом Подключение и конфигурирование настоящего руководства.

Разработка первого приложения с использованием программного продукта#

Пример вызовов публичного API и его методов приведен ниже.

Перечень методов API

API

Метод

Описание метода

Детализация

CentralBankRates Курсы ЦБ

getRate Курс ЦБ с конверсией

Получение курса ЦБ валюты на операционную дату. Всегда возвращает курс за N единиц валюты и масштаб N.

Входные параметры (входые параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

CentralBankRates Курсы ЦБ

getRates Список курсов за период

Получение списка курсов CБ валют/металлов (ОМС) на операционную дату для физических лиц. По каждой валютной паре возвращает курс за N единиц валюты и масштаб N Внимание : курсы предоставляются as−is, валютные пары из справочника

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

CentralBankRates Курсы ЦБ

getRateListByQuoteCurrency Список курсов ЦБ с конверсией по валюте котировки

Получение курса ЦБ по списку валют. Всегда возвращает M курсов за N единиц валюты и масштаб L.

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

ExchangeRatesForIndividuals Курсы ФЛ Компании

getRate Курс ФЛ с конверсией валюта−рубль

Получение курса валют Компании для физических лиц по заданным атрибутам на дату−время из входных параметров для валютной пары состоящей из валюты/рубль. Всегда возвращает курс за N единиц валюты и масштаб N. Внимание! Что касается индивидуального курса по клиенту, то это регулируется заполнением выходного атрибута "Признак индивидуального курса". Для того чтобы получить индивидуальный курс нужно чтобы данный курс был тиражирован последним для запрашиваемой даты/времени, во входных данных задан соответствующий ВСП и выбран соответствующий ERNP. Если тиража индивидуального курса нет на запрашиваемую дату/время, то вы получите обычный курс для выбранного ERNP

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

ExchangeRatesForIndividuals Курсы ФЛ Компании

getRates Список курсов ФЛ валюты

Получение списка курсов Компании валют/металлов (ОМС) на операционную дату для физических лиц. По каждой валютной паре возвращает курс за N единиц валюты и масштаб N Внимание : курсы предоставляются as−is, валютные пары из справочника

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта

ExchangeRatesForIndividuals Курсы ФЛ Компании

getCrossRate Кросс−курс ФЛ с конверсией валюта−валюта

Получение кросс−курса валют Компании для физических лиц по заданным атрибутам на дату−время из входных параметров для валютной пары состоящей из валюты/валюты. Всегда возвращает курс за N единиц валюты и масштаб N. Внимание! Что касается индивидуального курса по клиенту, то это регулируется заполнением выходного атрибута "Признак индивидуального курса". Для того чтобы получить индивидуальный курс нужно чтобы данный курс был тиражирован последним для запрашиваемой даты/времени, во входных данных задан соответствующий ВСП и выбран соответствующий ERNP. Если тиража индивидуального курса нет на запрашиваемую дату/время, то вы получите обычный курс для выбранного ERNP

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта). Метод основывается на принципе "обратного калькулятора" EUR/USD "buy": true "directOperation": true Базовая валюта EUR, котируемая USD

ExchangeRatesForIndividuals Курсы ФЛ Компании

getMetalRate Котировки металлов ФЛ с конверсией

Получение котировок металлов Компании для физических лиц по заданным атрибутам на дату−время из входных параметров для валютной пары состоящей из валюты/рубль. Всегда возвращает курс за N единиц валюты и масштаб N. Внимание! Что касается индивидуального курса по клиенту, то это регулируется заполнением выходного атрибута "Признак индивидуального курса". Для того чтобы получить индивидуальный курс нужно чтобы данный курс был тиражирован последним для запрашиваемой даты/времени, во входных данных задан соответствующий ВСП и выбран соответствующий PMR. Если тиража индивидуального курса нет на запрашиваемую дату/время, то вы получите обычный курс для выбранного PMR

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

ExchangeRatesForLegalEntities Курсы ЮЛ Компании

getRate Курс ЮЛ с конверсией валюта−рубль

Получение курса валют Компании для юридических лиц по заданным атрибутам на дату−время из входных параметров для валютной пары состоящей из валюты/рубль. Всегда возвращает курс за N единиц валюты и масштаб N.

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

getRates Список курсов валюты/металла ОМС

Получение списка курсов Компании валют/металлов (ОМС) на операционную дату для юридических лиц. По каждой валютной паре возвращает курс за N единиц валюты и масштаб N Внимание : курсы только по валютным парам из справочника.

Входные параметры (входные параметры представлены в документе Описание API продукта).

getCrossRate Кросс−курс ЮЛ с конверсией валюта−валюта

Получение кросс−курса валют Компании для юридических лиц по заданным атрибутам на дату−время из входных параметров для валютной пары состоящей из валюты/валюты. Всегда возвращает курс за N единиц валюты и масштаб N.

Входные параметры (входные параметры представлены в документе Описание API продукта). Выходные параметры (выходные параметры представлены в документе Описание API продукта)

Использование программного продукта#

Продукт Platform V Exchange Rates предоставляет потребителям:

  • значения курсов валют;

  • значения учетных цен драгоценных металлов;

  • значения ставок МКБ;

  • значения котировок финансовых инструментов;

  • сервис конверсионных расчетов.

Внутренние процессы, происходящие при запросе курсов:

  • модуль загрузки получает сообщение от мастера источника курсов;

  • выполняет обработку сообщений;

  • сохраняет курсы в БД;

  • формирует ответ;

  • отправляет ответ в систему мастер источник курсов.

Пример внешнего процесса, получения курса валюты Центробанка/котировки металла на начало каждого дня из переданного в запросе периода. При данном запросе используется метод getRates Список курсов за период. Внешний потребитель отправляет сообщение запроса:

{
    "jsonrpc": "2.0",
    "id": 111,
    "method": "getRates",
    "params": [
        {
            "codes": [
                "840",
                "978",
                "HelloWorld"
            ],
            "dateFrom": "2021−04−22T12:51:47.188",
            "dateTo": "2021−04−22T12:51:47.188"
        }
    ]
}

Система Exchange Rates принимает данное сообщение и возвращает ответ, данный процесс выполняется синхронно.

Ответ: список валют на одну дату

{
    "jsonrpc": "2.0",
    "id": 111,
    "result": [
        {
            "success": [
                {
                    "requestDate": "2021−04−30T23:59:59.000+03:00",
                    "rates": [
                        {
                            "currencyRate": 71.6993,
                            "startDate": "2021−04−30T00:00:00.000+03:00",
                            "baseAlphaCode": "EUR",
                            "baseNumericCode": "978",
                            "quoteAlphaCode": "RUB",
                            "quoteNumericCode": "643",
                            "lotSize": 1,
                            "type": "FXCB",
                            "rqUID": "FXCB_null"
                        },
                        {
                            "currencyRate": 65.5555,
                            "startDate": "2021−04−30T00:00:00.000+03:00",
                            "baseAlphaCode": "USD",
                            "baseNumericCode": "840",
                            "quoteAlphaCode": "RUB",
                            "quoteNumericCode": "643",
                            "lotSize": 1,
                            "type": "FXCB",
                            "rqUID": "FXCB_null"
                        }
                    ]
                }
            ]
        },
        {
            "errors": [
                {
                    "requestDate": "2021−04−30T23:59:59.000+03:00",
                    "rates": [
                        {
                           "code": "HelloWorld",
                            "error": {
                                "code": −31001,
                                "description": "По переданному коду: HelloWorld отсутствуют курсы валют."
                        }
                    ]
                }
            ]
        }
    ]
}

Описание примеров использования API Продукта приведены в документе Описание API Platform V Exchange Rates.

Часто встречающиеся проблемы и пути их устранения#

В настоящее время информации о возможных проблемах не имеется.