REST-API сервис
Распространяет ли Банк России программное обеспечение для взаимодействия посредством REST-API сервиса?
В настоящее время такое программное обеспечение не распространяется.
Как поступить, если при направлении запроса получен ответ «401 Unauthorized»?
В случае получения такого ответа необходимо убедиться в наличии в запросе метода авторизации, а также проверить корректность указанных учетных данных.
Что делать, если при создании нового сообщения методом POST получен ответ «Недоступна отправка сообщения по указанной задаче»?
Получение такого ответа означает, что используемой учетной записи участника информационного обмена недоступна отправка сообщений для задачи, указанной в теле запроса. Список доступных для конкретной учетной записи задач доступен для просмотра по запросу GET */tasks/.
Есть ли возможность выгрузить информацию только по прочитанным/новым/зарегистрированным сообщениям?
Для получения информации по сообщениям с конкретным статусом необходимо указать в запросе GET */messages/ параметр status. Возможные значения поля status:
|
Статус |
Статус в ЛК |
Описание |
|---|---|---|
|
sent |
Отправлено/Отправлен ответ |
Сообщение получено сервером |
|
delivered |
Загружено |
Сообщение прошло первоначальную проверку |
|
error |
Ошибка |
При обработке сообщения возникла ошибка |
|
processing |
Принято в обработку |
Сообщение передано во внутреннюю систему Банка России |
|
registered |
Зарегистрировано |
Сообщение зарегистрировано |
|
rejected |
Отклонено |
Сообщение успешно дошло до получателя, но было отклонено |
|
new |
Новое |
Только для входящих сообщений. Сообщение в данном статусе еще не прочитано участником информационного обмена |
|
read |
Прочитано |
Только для входящих сообщений. Сообщение в данном статусе прочтено пользователем |
|
replied |
Отправлен ответ |
Только для входящих сообщений. На сообщение в данном статусе направлен ответ |
|
success |
Доставлено |
Сообщение успешно размещено в личном кабинете / Сообщение передано роутером во внутреннюю систему Банка России, от которой не ожидается ответ о регистрации |
Как при отправке сообщений в Банк России следует заполнять параметр «SignedFile» для файлов вложений?
В параметре «SignedFile» файла, содержащего электронную подпись, необходимо указывать значение параметра «Name» подписанного файла. Для иных файлов поле не заполняется.
Что означает ответ «Превышена квота дискового пространства для данного УИО» при создании нового сообщения методом POST?
Данный ответ означает, что суммарный размер прилагаемых к сообщению файлов превышает доступное пространство квоты для хранения истории обмена электронными сообщениями. Размер максимальной и используемой квоты можно получить запросом GET */quote/. Для очистки дискового пространства необходимо удалять сообщения из личного кабинета участника информационного обмена, сохраняя данные локально.
Что делать, если после успешной отправки письма в Банк России получена ошибка «Адресат Департамент операций на открытом рынке не найден в справочнике адресатов»?
Необходимо убедиться, что наименование адресата было введено корректно. Письма в Банк России должны быть направлены согласно трехуровнему справочнику адресации, доступному в разделе личного кабинета участника информационного обмена «Справочники», а также по запросу GET */dictionaries/.
Как исправить ошибку значения content-range, возникшую при отправке файла чанками?
При отправке чанка сообщения необходимо учитывать, что первый байт файла занимает порядковую позицию «0». Соответственно, чанк, занимающий первые 100 000 байт, имеет content-range, равный
Как сформулировать запрос, если необходимо получить информацию обо всех сообщениях в личном кабинете участника информационного обмена, а при запросе выдаются только последние?
При запросе GET */messages/ в ответ отправляется страница из хронологически последних 100 сообщений. Информация об общем количестве сообщений и количестве страниц соответственно доступна в header ответа.
Для получения конкретной страницы необходимо направить запрос GET */messages/?page={n}, где n — номер страницы.
Как трактуется значение NULL, которое появляется у некоторых файлов в элементе RepositInfo при получении списка сообщений методом GET: */messages?
NULL возникает, если запрашивается информация о сообщении, для которого нет файлов на сервере личного кабинета участника информационного обмена (они были удалены или отправлены по потоку, который не подразумевает сохранение в личном кабинете участника информационного обмена).