Сервис для работы с авторизационными данными пользовательских систем

Обновлено 19 сентября 2023

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

• Текущий тестовый контур https://edupirfintech.sberbank.ru:9443

• Новый тестовый контур https://iftfintech.testsbi.sberbank.ru:9443

• Промышленный контур https://fintech.sberbank.ru:9443

Сервис предоставляет возможность хранить учетные данные, полученные по авторизации oAuth 2.0, других систем за контуром Банка.

Добавление авторизационных данных

Ресурс /v1/external-system-auth-profiles позволяет Партнеру добавить авторизационные данные клиента или обновить при повторном обращении клиента к сервису Партнера.

Шаги

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

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

Для добавления/обновления необходимо отправить POST-запрос (/v1/external-system-auth-profiles), в котором передать авторизационный токен к данным клиента/собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

Наименование	Описание
Authorization (String)	Access token организации-клиента/собственной организации, полученный через SSO Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры тела запроса
ExternalSystemAuthProfile {
accessToken (string, optional)	Access токен,
accessTokenExpiresIn (string, optional)	Дата и время окончания действия accessToken,
commentary (string, optional)	Произвольный комментарий,
extSystemId (integer)	Идентификатор внешней системы,
extSystemUserId (string, optional)	Идентификатор пользователя во внешней системе,
extSystemUserLogin (string, optional)	Логин пользователя во внешней системе,
refreshToken (string, optional)	Refresh токен,
refreshTokenExpiresIn (string, optional)	Дата и время окончания действия refreshToken,
tokenType (string, optional)	Тип токена
}

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

{
"accessToken": "c76fb018-27c9-43f7-a751-62646eda7e1a-1",
"accessTokenExpiresIn": "2018-12-31T23:59:59",
"commentary": "Произвольный текст",
"extSystemId": 12345,
"extSystemUserId": "12345dfff",
"extSystemUserLogin": "qwerty",
"refreshToken": "h45fb018-27c9-43f7-a678-62646eda7e1a-1",
"refreshTokenExpiresIn": "2018-12-31T23:59:59",
"tokenType": "Bearer"
}

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

Только http-код

Получение ранее добавленных данных

Ресурс /v1/external-system-auth-profiles/{extSystemId} позволяет Партнеру получить ранее добавленные авторизационные данные клиента.

Шаги

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

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

Для добавления/обновления необходимо отправить POST-запрос (/v1/external-system-auth-profiles), в котором передать авторизационный токен к данным клиента/собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента/собственной организации, полученный через SSO Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
extSystemId (long)	Идентификатор внешней системы

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

curl -X GET --header 'Accept: */*' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'http://edupirfintech.sberbank.ru:9443/fintech/api/v1/external-system-auth-profiles/12345dfff'

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

Наименование	Описание
ExternalSystemAuthProfile {
accessToken (string, optional)	Access токен,
accessTokenExpiresIn (string, optional)	Дата и время окончания действия accessToken,
commentary (string, optional)	Произвольный комментарий,
extSystemId (integer)	Идентификатор внешней системы,
extSystemUserId (string, optional)	Идентификатор пользователя во внешней системе,
extSystemUserLogin (string, optional)	Логин пользователя во внешней системе,
refreshToken (string, optional)	Refresh токен,
refreshTokenExpiresIn (string, optional)	Дата и время окончания действия refreshToken,
tokenType (string, optional)	Тип токена
}

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

{
"accessToken": "c76fb018-27c9-43f7-a751-62646eda7e1a-1",
"accessTokenExpiresIn": "2018-12-31T23:59:59",
"commentary": "Произвольный текст",
"extSystemId": 12345,
"extSystemUserId": "12345dfff",
"extSystemUserLogin": "qwerty",
"refreshToken": "h76fb018-27c9-43f7-a867-62646eda7e1a-1",
"refreshTokenExpiresIn": "2018-12-31T23:59:59",
"tokenType": "Bearer"
}

Удаление ранее добавленных данных

Ресурс /v1/external-system-auth-profiles/{extSystemId} позволяет Партнеру удалить ранее добавленные авторизационные данные клиента.

Шаги

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

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

Для удаления данных необходимо отправить DELETE-запрос (/v1/external-system-auth-profiles/{extSystemId}), в котором передать авторизационный токен к данным клиента/собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента/собственной организации, полученный через SSO Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
extSystemId (long)	Идентификатор внешней системы

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

curl -X DELETE --header 'Accept: */*' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'http://edupirfintech.sberbank.ru:9443/fintech/api/v1/external-system-auth-profiles/12345dfff'

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

Только http-код

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

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