Получение показателей СберРейтинга по контрагентам

Обновлено 30 января 2025

POST

/v1/sberrating/traffic-lights

Получение показателей СберРейтинга по контрагентам

Request

Header Parameters

Authorization

string

required

Access token организации

X-Request-Id

string

required

Уникальный идентификатор запроса

X-Requestor

string

required

Возможные значения: <= 10 characters

Код АС, запрашивающей информацию

• application/json

Body

required

organizations object[]
Массив организаций
Array [
inn
string
nullable
ИНН клиента, по которому запрашивается СберРейтинг
kpp
string
nullable
КПП клиента, по которому запрашивается СберРейтинг
]

Ответы

• 200
• 400
• 500
• 503

OK

• application/json

• Схема
• Пример из схемы

Schema

warning

string

nullable

Возможные значения: <= 4000 characters

Предупреждение, если что-то пошло не так

message objectnullable
Бизнес-информация
description
string
Возможные значения: <= 4000 characters
Описание продукта СберРейтинг
organizations object[]
Массив организаций
Array [
inn
string
nullable
ИНН клиента, по которому запрашивается СберРейтинг
kpp
string
nullable
КПП клиента, по которому запрашивается СберРейтинг
indicators object[]
Массив данных по показателям СберРейтинга
Array [
indicatorSystemName
string
Возможные значения: <= 100 characters
Системное имя показателя
indicatorName
string
Возможные значения: <= 100 characters
Отображаемое имя показателя
levelSystemName
string
Возможные значения: <= 100 characters
Цвет показателя
levelDescription
string
Возможные значения: <= 100 characters
Текст цвета показателя
hintText
string
Возможные значения: <= 4000 characters
Текст раздела показателя
]
]

{
  "warning": "string",
  "message": {
    "description": "string",
    "organizations": [
      {
        "inn": "string",
        "kpp": "string",
        "indicators": [
          {
            "indicatorSystemName": "string",
            "indicatorName": "string",
            "levelSystemName": "string",
            "levelDescription": "string",
            "hintText": "string"
          }
        ]
      }
    ]
  }
}

BAD_REQUEST

• application/json

• Схема
• Пример из схемы

Schema

warning

string

nullable

Возможные значения: <= 4000 characters

Предупреждение, если что-то пошло не так

{
  "warning": "string"
}

INTERNAL_SERVER_ERROR

• application/json

• Схема
• Пример из схемы

Schema

warning

string

nullable

Возможные значения: <= 4000 characters

Предупреждение, если что-то пошло не так

{
  "warning": "string"
}

SERVICE_UNAVAILABLE

• application/json

• Схема
• Пример из схемы

Schema

warning

string

nullable

Возможные значения: <= 4000 characters

Предупреждение, если что-то пошло не так

{
  "warning": "string"
}

Loading...

Loading...