Создание письма для целей ВК (в банк)
Для создания и отправки письма в ВК необходимо отправить POST-запрос /fintech/api/v1/curr-control-messages/to-bank с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами письма в теле.
В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_TO_BANK для получения доступа к этому запросу.
- Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
- Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.
Дайджест это текстовый документ, содержащий перечень и значения полей запроса, к которому он относится и предназначенный для подписания ЭЦП. Сохраняйте порядок и количество полей дайджеста, как показано в примере ниже, иначе подписать его не получится.
Формат дайджеста:
| Наименование поля | Описание поля | Пример |
|---|---|---|
| authPersonName | ФИО ответственного лица | Петров Петр Иванович |
| authPersonTelfax | Телефон ответственного лица | 79263689379 |
| date | Дата документа | 28.02.2019 |
| externalId | Идентификатор документа в организации-партнере | 550e8400-e29b-41d4-a716-446655440000 |
| orgName | Наименование организации клиента | ООО "ТЕСТ" |
| subject | Тема письма | Договор ВК |
| text | Текст письма | Добрый день! |
| TABLES | Значение указывается при наличии UUID-ов больших файлов | |
| Table=BfAttachments | Значение указывается при н аличии UUID-ов больших файлов | |
| fileId | UUID больших файлов | 31663ef5-7975-4016-b0f3-f1d70a4e9c22 |
| # | Разделитель значений UUID-ов больших файлов | |
| fileId | UUID больших файлов | 51663ef5-7975-4016-b0f3-f1d70a4e9c22 |
| # | Разделитель значений UUID-ов больших файлов |
Пример дайджеста:
aauthPersonName=Иванов Алексей Сергеевич
authPersonTelfax=8(495)1234567
date=2019-04-16
externalId=31663ef5-7975-4016-b0f3-f1d70a4e9c22
orgName=ООО"Риэль"
subject=ТЕМА ПИСЬМА
text=ТЕКСТ ПИСЬМА
TABLES
Table=BfAttachments
fileId=31663ef5-7975-4016-b0f3-f1d70a4e9c22
#
fileId=51663ef5-7975-4016-b0f3-f1d70a4e9c22
#
При тестировании создания письма для целей ВК в Песочнице соблюдайте правила:
- Не нужно устанавливать промышленные сертификаты электронной подписи (ЭП) — Песочница использует тестовые идентификаторы ЭП (certificateUuid).
- Все остальные поля запроса заполняйте произвольными данными (реквизиты, суммы) в соответствии с требованиями в документации.
Сценарии тестирования
Для тестирования сценариев используйте фиксированные значения certificateUuid. При использовании любых других значений certificateUuid вернется ошибка INVALIDEDS.
1. Чтобы создать черновик письма для целей ВК, отправьте запрос без объекта digestSignatures.
2. Для отправки документа с единственной или двумя подписями передайте в объекте digestSignatures тестовые certificateUuid.
Параметры:
- bb014b5d-8159-40be-97c1-eafeed4a8c3d (единственная подпись)
- d5d4f811-f4d4-4205-a70f-58f772eeab72 (первая подпись)
- 4f29c8ef-b55d-43c7-a321-f2b1303a29cd (вторая подпись)
Статус в ответе: bankStatus: "EXPORTED"
Пример:
#Единственная подпись
"digestSignatures": [
\{
"certificateUuid": "bb014b5d-8159-40be-97c1-eafeed4a8c3d",
"base64Encoded": "MIILDgYJKoZIhvcNAQcCoIIK..."
\}
],
#Первая и вторая подпись
"digestSignatures": [
\{
"certificateUuid": "d5d4f811-f4d4-4205-a70f-58f772eeab72",
"base64Encoded": "MIILDgYJKoZIhvcNAQcCoIIK..."
\},
\{
"certificateUuid": "4f29c8ef-b55d-43c7-a321-f2b1303a29cd",
"base64Encoded": "MIILDgYJKoZIhvcNAQcCoIIK..."
\}
],
Запрос
Ответы
Created
Операция не завершена полностью
Ошибка в запросе или его жизненном цикле
| Cause | Message | Description |
|---|---|---|
| DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в response в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос. |
| VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
Не авторизован
| Cause | Message | Description |
|---|---|---|
| UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
Запрещено
| Cause | Message | Description |
|---|---|---|
| ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CURR_CONTROL_MESSAGE_FROM_BANK. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
"Превышен лимит запросов"
| Cause | Message | Description |
|---|---|---|
| TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустим ое значение. Пользователю необходимо повторить запрос позднее |
Внутренняя ошибка сервера
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
Сервис временно недоступен
| Cause | Message | Description |
|---|---|---|
| UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |