ym88659208ym87991671
Подключение пакета услуг Базовое решение | Документация для разработчиков

Подключение пакета услуг Базовое решение

Обновлено 20 апреля 2022

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

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

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

Получение списка клиентов

Ресурс /v1/clients-added позволяет Партнеру получить список клиентов, которые были подключены и переподключены к сервисам Партнера в ВСП за запрашиваемый период (в пределах одного дня).

Шаги

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

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

Для получения списка необходимо отправить GET-запрос (/v1/clients-added), в котором передать авторизационный токен к данным собственной организации (Access Token) и период за который запрашивается информация. Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token собственной организации, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
datetimeSince (String)Дата и время начала периода (yyyy-MM-dd'T'HH:mm:ss)
datetimeUntil (String)Дата и время окончания периода (yyyy-MM-dd'T'HH:mm:ss)

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'http://edupirfintech.sberbank.ru:9443/fintech/api/v1/clients-added?datetimeSince=2020-01
20%2010%3A20%3A00&datetimeUntil=2020-01-21%2010%3A20%3A00

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

НаименованиеОписание
ClientsAdded {
clientsAdded (Array[ClientAdded], optional)Информация о клиентах
}ClientAdded {
hashOrgId (string, optional)Хэш идентификатора организации,
usersInfo (Array[ClientAddedUserInfo], optional)Информация о пользователях
}ClientAddedUserInfo {
servicesInfo (Array[ClientAddedUserServiceInfo], optional)Подключенные в ВСП платные сервисы,
sub (string, optional)Хэш идентификатора пользователя
}ClientAddedUserServiceInfo {
clientId (integer, optional)Идентификатор сервиса,
refreshToken (string, optional)Токен обновления
}

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

{
"clientsAdded": [{
"hashOrgId": "string",
"usersInfo": [{
"servicesInfo": [
{
"clientId": 0,
"refreshToken": "string"
}],
"sub": "string"
}]
}]
}

Получение сведений о клиентах

Ресурс /v1/partner-info/package-of-services позволяет Партнеру получить сведения о клиентах, подключенных к пакетам услуг с небанковскими сервисами.

Шаги

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

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

Для получения документа необходимо отправить GET-запрос (/v1/partner-info/package-of-services), в котором передать авторизационный токен (Access Token) и дату (подключения/отключения/изменения статуса ПУ). Авторизационный токен передается в параметре Authorization заголовка запроса.

Данный сервис используется для получения информации о состоянии пакета услуг с небанковскими сервисами, подключенного через:

  • СберБизнес (онлайн канал)
  • ВСП (офлайн канал)

Если партнер использует ЗДА, то информацию о статусе пакета услуг с НБС можно получить в рамках сервиса GET /v1/partner-info/advance-acceptances.

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token собственной организации, полученный через SSO
Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Параметры запроса
date (String)Дата (подключения/отключения/изменения статуса ПУ)
Пример: 2018-09-12

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/partner-info/package-of-services&date=2018-09-12'

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

НаименованиеОписание
subscribes {
Inn (String)ИНН плательщика,
orgName (String)Наименование организации,
orgIdHash (String)Хэш от идентификатора организации клиента,
bundles (Array[AdvanceAcceptanceBundle]) {
code (String)Код пакета услуг. Возможные варианты: LIGHTSTB, ONBORTB, POLNHODB ,
guid (String)Уникальный идентификатор пакета ,
name (String)Наименование пакета услуг ,
sinceDate (String)Дата подключения ,
untilDate (String)Дата отключения ,
currentState (String, optional)Статус пакета услуг в настоящее время. Возможные варианты представлены в таблице статусов
}

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

{
"Inn":"7733812920",
"orgName":"Общество с ограниченной ответственностью Ромашка",
"orgIdHash":"31256b9025db931f02f2353213061d46f309ba09fc5464cb4c14c2f69abf7024",
"bundles":[
{
"code":"POLNHODB",
"guid":"",
"name":"Полным ходом",
"sinceDate":"2018-12-31",
"untilDate":"2019-12-31",
"currentState":"ACTIVE"
}
]
}

Таблица статусов поля currentState

Небанковские сервисы с офертой:

СтатусЗначение
ACTIVEПакет услуг оплачен
NOT_PAIDПакет не оплачен

Небанковские сервисы без оферты:

СтатусЗначение
ACTIVEПакет услуг оплачен
NOT_PAIDПакет не оплачен
DEACTIVATEDПакет услуг деактивирован

Дополнительная информация

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

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

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

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