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

Обновлено 29 февраля 2024

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

Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
Промышленный контур https://fintech.sberbank.ru:9443

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

Ресурс /v1/partner-info/request-statistics позволяет получить статистику по количеству запросов к API.

Шаги

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

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

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

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

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token, полученный через SSO Пример: `Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1`
Параметры запроса
dateSince (Date)	Дата начала периода (yyyy-MM-dd)
dateUntil (Date)	Дата окончания периода (yyyy-MM-dd)
clientId (String)	Идентификатор сервиса

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'https://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/partner-info/request-statistics?
dateSince=2020-01-21&dateUntil=2020-01-25&clientId=0000'

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

Наименование	Описание
RequestStatistics {
billingObjects (Array[BillingObjectStatistics], optional)	Статистика тарифицируемых запросов,
nonBillingObjects (Array[BillingObjectStatistics], optional)	Статистика нетарифицируемых запросов
}
BillingObjectStatistics {
numberRequests (integer, optional)	Количество запросов за период,
serviceName (string, optional)	Наименование запроса,
serviceSystemName (string, optional)	Системное наименование запроса
}

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

{
   "billingObjects":[
      {
         "numberRequests":1000,
         "serviceName":"Код авторизации",
         "serviceSystemName":"sso-authorize"
      }
   ],
   "nonBillingObjects":[
      {
         "numberRequests":1000,
         "serviceName":"Код авторизации",
         "serviceSystemName":"sso-authorize"
      }
   ]
}

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

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

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