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

Обновлено 29 ноября 2024

Компаниям

Холдингам

Платформам

/fintech/api/v1/files/tasks-for-download/{taskId}

Запрос позволяет получить ссылку для загрузки печатной формы файла выписки по ранее сформированной задаче.

Для получения ссылки на загрузку необходимо отправить GET-запрос /fintech/api/v1/files/tasks-for-download/{taskId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором задачи (taskId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис FILES для получения доступа к этому запросу.

После получения ответа 200 OK со статусом готовности файла к скачиванию EXECUTED, платформа осуществляет скачивание файла по предоставленному URL.

Обратите внимание, что для успешного выполнения этого запроса требуется наличие установленного TLS-сертификата на платформе.

Загруженный файл сохраните в базе данных платформы. Это действие позволит организовать эффективное хранение и управление доступом к файлам.

Платформа предоставляет пользователям доступ к файлам из своей базы данных. Это гарантирует, что пользователи не столкнутся с проблемами доступа, связанными с отсутствием TLS-сертификата на их устройствах.

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

Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v1/files/tasks-for-download/{taskId}

Модель
Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
PATH PARAMETER
taskId	string	string	^.+$	required	Идентификатор задачи на скачивание. Вы его получаете с помощью запросов `/fintech/api/v1/statement/print` или `/fintech/api/v1/statement/files`

GET /fintech/api/v1/files/tasks-for-download/247258305314631 HTTP/1.1
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678

Responses

200 (OK)

Модель
Пример

Наименование	Тип	Обязательность	Описание
TaskForDownload {
filename	string	optional	Имя файла
id	string	optional	Идентификатор файла,
state	string	optional	Статус загрузки файла,
url	string	optional	Ссылка для загрузки файла
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "filename": "Выписка за 2020.05.08 счет 40802810600000200000.zip",
  "id": 1,
  "state": "CREATED",
  "url": "https://apifiles.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb02d39d400bcd"
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "DESERIALIZATION_FAULT",
    "referenceId": "4a0e6754-ad22-4d7d-ac82-810afd08b5b2",
    "message": "Неверный формат запроса",
    "checks": [
        {
            "level": "ERROR",
            "message": "Cannot deserialize instance of `java.util.ArrayList<Signature>` out of START_OBJECT token",
            "fields": [
                "digestSignatures"
            ]
        }
    ],
    "fieldNames": [
        "digestSignatures"
    ]
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция `FILES`. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

Статусы готовности к загрузке

bankStatus (string)

Статус	Значение
Промежуточный / Продолжать опрашивать
`PROCESSING`	Выписка в процессе формирования
Окончательные статусы / Прекратить опрос
`ERROR`	Ошибка формирования выписки
`EXPIRED`	Срок действия ссылки истек
Окончательные статусы (успешные) / Прекратить опрос
`EXECUTED`	Выписка сформирована

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

Статусы готовности к загрузке﻿

Статусы готовности к загрузке