Получение количества ЗДА

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

Ресурс fintech/api/v1/partner-info/clients-added-info

Ресурс возвращает количество организаций, которые подключили подписку партнёра за период. Клиенты, которые в заданный интервал времени произвели отказ от оферты в ответ не попадают.

Разница между датой начала и датой окончания выборки не должна превышать 1 месяц. В противном случае возвращается код ошибки 400.

Шаги

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

2. Сформировать ЭП.

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

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

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

Header Parameters Тип данных
Описание поля
Пример
Authorization String
Access token полученный через SSO
Пример c76fb018-27c9-43f7-a751-62646eda7e1a-1
Query Parameters
dateSince Date
Дата начала выборки
Пример 12-09-2018
dateUntil Date
Дата окончания выборки
Пример 15-09-2018
clientId Long
Идентификатор клиента
Пример1073

Получение информации о подключенных клиентах возможно только по собственной организации.

Пример

curl -X GET --header 'Accept: application/json' --header 
'Authorization: fefed58b-8d3d-4c3a-8a51-435992066044' 
'https://fintech.sberbank.ru:9443/fintech/api/v1/partner-info/clients-added-info?dateSince=12-09-2021&dateUntil=15-09-2018&clientId=1073'

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

Parameters Тип данных
Описание
Пример
orgQuantity Integer
Количество организаций с активными подключениями
Пример 3
dateSince Date
Дата начала выборки
Пример 12-09-2018
dateUntil Date
Дата окончания выборки
Пример 15-09-2018
clientId Long
Идентификатор клиента Пример1073

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

ClientsAddedInfo {
  "clientId": "1073",
  "orgQuantity": 10,
  "sinceDate": "2018-09-12",
  "untilDate": "2018-09-15"
}

Причины возникновения ошибок

Возвращаются в json в случае критической ошибки

Код возврата Описание кода возврата Причина возникновения
400 DESERIALIZATION_FAULT
Неверный формат запроса
Неверный формат запроса

Разница между датой начала и датой окончания превышает 1 месяц
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
Указан некорректный или просроченный access_token.
403
ACTION_ACCESS_EXCEPTION
User don't have effective permissions for class=[FintechPartnerInfoServiceImpl], method=[Название метода]"
У пользователя нет прав на использование соответствующего сервиса Fintech API, доступ к которому не предусмотрен настройками scope
У пользователя отсутствует оферта с внешним сервисом
ClientId не найден
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера

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

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