Информация о сервисе
Сервис «Большие файлы» — ваш помощник в работе с документами.
С помощью сервиса вы сможете загружать документы в банк для различных целей, например:
- предоставление документов в валютный контроль Банка;
- экспорт файлов с выписками по счетам для импорта в другие системы;
- отправка в Банк иных документов по разным вопросам.
Сервис позволит разместить в пространстве Банка ваши файлы для их последующего прикрепления к другим документам при отправке запросов API.
Варианты реализации
Ниже будут приведены примеры реализации. Сценарии могут быть для вас отправной точкой и идеей для финального способа реализации функциональности.
Сценарии описали общие, для более легкого восприятия информации описания работы с сервисом.
Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.
Загрузка файлов в Банк
Этот сценарий позволяет загружать файлы и документы в систему Банка. Ссылки на эти файлы и документы можно будет использовать в запросах API.
Мы рекомендуем использовать сценарий с автоматическим запуском в других сценариях.
Представим, что ваша Платформа предлагает Пользователю создать запрос на постановку контракта на учет через форму в пользовательском интерфейсе (UI). В этой форме Пользователь загружает документы контракта.
Когда файлы загружаются в UI Платформы, и Пользователь подтверждает отправку запроса, автоматически запускается соответствующий сценарий для каждого файла.
Шаги
- Получить ссылку для загрузки
- Загрузить файл
- Получить статус загрузки
Участники usecase
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предварительные условия
- Запускается внутри одного из сценариев
- У Платформы есть токены доступа Пользователя, полученные с помощью СберБизнес ID
Результат применения
- Файл загружен в Банк
- Платформа получила ссылку на файл в системе Банка
Используемые запросы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 |  | /fintech/api/v1/files/upload | Запрос ссылки на загрузку файла в Банк | FILES | 1. Получить ссылку для загрузки |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить ссылку для загрузки |
| 3 |  | /fintech/api/v1/files/upload/{fileId}/state | Получение статуса загрузки файла в Банк | FILES | 3. Получить статус загрузки |
Скачивание ранее загруженных файлов
Этот сценарий позволяет скачивать ранее загруженные в Банк документы.
Шаги
- Запросить подготовку файла для скачивания
- Получить статус загрузки
- Скачать файл
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предварительные условия
- Запуск доступен только при реализации хотя бы 1 раз сценария "Загрузка файлов в Банк"
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Результат применения
- Файл скачен в пространство Платформы
- Платформа предоставила файл Пользователю в своем UI
Используемые запросы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v1/files/download | Запрос ссылки на выгрузку файлов | FILES | 1. Запросить подготовку файла для скачивания |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Запросить подготовку файла для скачивания |
| 3 | | /fintech/api/v1/files/downloadState | Получение статусов выгрузки файлов | FILES | 2. Получить статус загрузки |
Доступные форматы файлов для загрузки в Банк
Сервис является вспомогательным при работе в сценариях других сервисов Sber API.
Возможные форматы и типы файлов, а также другие ограничения зависят от сервиса, в рамках которых будет участвовать Большие файлы.
- ВЭД
- Переписка с банком
subType:
InternalControlStatement - Ведомость банковского контроля (ВБК)
ConfDocInq_138I - Справка о подтверждающих документах (СПД)
CurrencyOperationDetails - Сведения о валютной операции (СВО)
CCMessageToBank - Письмо для целей ВК (в банк)
Размерность файла - до 30 Мбайт
Форматы файлов - pdf, jpeg, jpg, png, tiff, tif, pcx
subType:
GenericLetterToBank - Письмо свободного формата
Размерность файла - до 50 Мбайт
Форматы файлов - pdf, jpeg, jpg, png, tiff, tif, pcx, txt, doc, docx, rar, zip, xls, xlsx
Загрузка файла в Банк
Загрузка файла по полученной ссылке осуществляется через составной POST-запрос с параметром multipart/form-data
Пример:
curl -v -F 'fileName=File_upl.pdf' https://{host}:{port}/sbns-app/upload/{fileId}
Где fileName=File_upl.pdf - имя загружаемого файла, https://{host}:{port}/sbns-app/upload/{fileId} - ссылка, полученная с помощью ресурса /fintech/api/v1/files/upload/.