Онлайн бизнес-миссия

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

Формирование черновика заявления

Ресурс /v1/obm-request/business-mission позволяет сформировать черновик заявления на оказание консалтинговых услуг с переданным идентификатором онлайн бизнес миссии, которую выбрал клиент на стороне партнера.

Шаги

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

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

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

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

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

Header Parameters Описание
Authorization String
Access token организации-клиента, полученный через SSO.
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Body Parametrs Описание
externalId String
Идентификатор заявления на консалтинговые услуги
missionId String
Идентификатор онлайн бизнес миссии
backUrl String, optional
Ссылка на сайт партнера, для переадресации клиента после подписания заявления

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

{

"extrenalId": "a0000000-0000-0000-0000-000000000001"

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

"backUrl":  "https://example.ru"

}

Получение статуса заявления

Ресурс /v1/obm-request/{externalId}/state позволяет получить статус заявления на консалтинговые услуги.

Шаги

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

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

Для получения статуса необходимо отправить GET-запрос (/v1/obm-request/{externalId}/state), в котором необходимо передать авторизационный токен к данным организации партнера/собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

Header Parameters Описание
Authorization String
Access token, полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Query Parameters Описание
externalId String
Идентификатор заявления на консалтинговые услуги в организации-партнера

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

curl -X GET --header "Accept: /" --header

"Authorization: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1"

"https://edupirfintech.sberbank.ru:9443/fintech/api/v1/obm-request/ffffffff-fffa-458e-ad92-fff9497303ba/state"

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

ConsultRequest {
bankStatus (string, optional, read only) Статус заявления на консалтинговые услуги,
bankComment (string, optional, read only) Комментарий к статусу заявления на консалтинговые услуги
}

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

{

"bankStatus": "Draft",

"bankComment": "Комментарий к статусу"

}

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

Код возврата Описание кода возврата Причина возникновения
200 (GET-запроса) OK
201 (POST-запрос) CREATED
Создан
400 DESERIALIZATION_FAULT
Неверный формат запроса Неверный формат запроса
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х Указан некорректный или просроченный access_token.
403 ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещен У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
404 NOT_FOUND
Документ с указанным ID не найден Невозможно найти документ с указанным внешним идентификатором.
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503 UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступен Проводятся технические работы

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

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