Большие файлы

Для обращения к ресурсу необходимо отправлять запрос на:

Получение ссылки на скачивание файла

Ресурс /v1/files/download позволяет получить ссылку для скачивания файла. Скачать файл после получения ссылки возможно только после получения положительного статуса о готовности файла для скачивания. Проверка статуса осуществляется с помощью ресурса /v1/files/downloadState.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

3. Получить статус.

Для создания запроса ссылки на скачивание файла необходимо отправить POST-запрос (/v1/files/download), в заголовке запроса необходимо передать авторизационный токен организации (Access Token).

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.

Модель запроса

Header Parameters
Authorization String
Access token организации полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Body
FileDownloadRequest {
fileIds (Array[string]) Список идентификаторов файлов
}

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

{

"fileIds": [

"TwyoRxWisy_YQI6hBHGKZSOAYrzV-LTz0I_Jy5eTMEpTJW4_R_W8y9_2StuKtv8p"

]

}

Получение статуса файла

Ресурс /v1/files/downloadState позволяет получить статус о готовности файла для скачивания.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения статуса необходимо отправить POST-запрос (/v1/files/downloadState), в котором передать авторизационный токен к данным организации (Access Token) и список идентификаторов файлов (fields). Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.

Модель запроса

Header Parameters
Authorization String
Access token полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Body
FileDownloadStateRequestt {
fileIds (Array[string]) Список идентификаторов файлов
}

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

{

"fileIds": [

"TwyoRxWisy_YQI6hBHGKZSOAYrzV-LTz0I_Jy5eTMEpTJW4_R_W8y9_2StuKtv8p"

]}

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

FileDownloadStateRequest [
FileDownloadStateRequest 1
]FileDownloadStateRequest 1 {
bankComment (string, optional) Банковский комментарий к статусу загрузки файла,
fileId (string, optional) Идентификатор файла,
status (string, optional) Статус загрузки файла = [PREPARING_FOR_DOWNLOAD, READY_FOR_DOWNLOAD, ERROR, OUTDATED, SPOILED, UNKNOWN_STATUS]
stringEnum: PREPARING_FOR_DOWNLOAD, READY_FOR_DOWNLOAD, ERROR, OUTDATED, SPOILED, UNKNOWN_STATUS
url (string, optional) Ссылка для загрузки файла
}

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

[{

"bankComment": "string",

"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",

"status": "PREPARING_FOR_DOWNLOAD",

"url": "https://bf.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb-02d39d400bcd"

}]

Получение ссылки для загрузки формы

Ресурс /v1/files/tasks-for-download позволяет получить ссылку для загрузки печатной формы файла выписки, по ранее сформированной задаче.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения ссылки необходимо отправить GET-запрос (/v1/files/tasks-for-download), в котором передать авторизационный токен к данным организации (Access Token) и идентификатор задачи. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.

Модель запроса и ответа

Header Parameters
Authorization String
Access token полученный через SSO.
Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Path Parameters
taskId String
Идентификатор задачи на скачивание.

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

curl -X GET --header 'Accept: application/json' --header

'Authorization: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/files/

tasks-for-download/5120f687-c916-300b-9d68-0ce22f4f3f9d'

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

TaskForDownload {
filename (string, optional) Имя файла ,
id (integer, optional) Идентификатор ,
state (string, optional) Состояние = ['CREATED', 'PROCESSING', 'ERROR', 'EXECUTED', 'EXPIRED'],
url (string, optional) Ссылка для загрузки файла
}

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

{

"filename": "Выписка за 2020.05.08 счёт 40802810600000200000.zip",

"id": 1,

"state": "CREATED",

"url": "https://bf.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb

02d39d400bcd"

}

Возможные статусы

Код статуса Наименование Состояние
PREPARING_FOR_DOWNLOAD Подготовка файла к загрузке Промежуточный / Продолжать опрашивать
READY_FOR_DOWNLOAD Файл готов к загрузке Конечный результат (Успешный) / Прекратить опрос
ERROR Ошибка загрузки файла Конечный / Прекратить опрос
OUTDATED Задача загрузки устарела Конечный / Прекратить опрос
SPOILED Задача загрузки замещена другой Конечный / Прекратить опрос
UNKNOWN_STATUS Неизвестный статус загрузки файла Промежуточный / Продолжать опрашивать

Дополнительная информация

Коды возврата

Код возврата Описание кода возврата Причина возникновения
200 (GET-запроса) OK
201 (POST-запрос) CREATED
Создан
400 DESERIALIZATION_FAULT
Неверный формат запроса Неверный формат запроса
WORKFLOW_FAULT
Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХ Для внешнего сервиса недоступны операции по счету: счет не добавлен в список разрешенных в оферте; внешний сервис заблокирован в СББОЛ; счет указан неверно. Отсутствует доступный открытый рублевый расчетный счет у организации плательщика
Документ с такими реквизитами уже существует Документ с такими реквизитами уже существует. Проверка по номер документа в течении года.
Не указан идентификатор сертификата подписи Не указан идентификатор сертификата подписи(параметр kid заголовка JWS)
Некорректный формат параметра kid заголовка JWS Некорректный формат параметра kid заголовка JWS(ожидается UUID)
VALIDATION_FAULT
Ошибка валидации Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х Указан некорректный или просроченный access_token.
403 ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещен У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
404 DATA_NOT_FOUND_EXCEPTION
Не найдено ни одного заранее данного акцепта за указанную дату Не найдено ни одного заранее данного акцепта за указанную дату
415 JWS_EXCEPTED
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization Ошибка возникает, если в настройках внешних сервисов выставлен флаг «Требуется подпись для внешнего сервиса»
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503 UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступен Проводятся технические работы

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней