Сервис получения результатов оценки

Обновлено 26 декабря 2023

Описание сервиса получения результатов оценки

С помощью данного API Клиенты могут получать результаты оценки клиентов и других участников на благонадежность при совершении финансовых и других сделок.

Используемые форматы перечислены здесь. С правилами формирования сообщения можно ознакомиться здесь.

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

Параметр вызова	Значение
Endpoint	https://api.sberbank.ru:8443/prod/skif/chs/v1/responses/{uid}
HTTP метод	GET
Request Parameters
Authorization (в заголовке)	Bearer 3d2fd034-a26b-4105-a8f6-8e8888152c7c Полученный токен по этой инструкции
RqUID (в заголовке)	82f1511cb0e145dda6c48ef732a14f9a
uid (в url)	9d80b949c362419584faeca9d8567b63
Request Body	Тело запроса отсутствует
Response Code	HTTP-код результата ответа
Response Parameters
Response Body	XML элемент типа srvGetCreditHistoryAndFraudScoreRs

Классификация возвращаемых кодов

Код	Описание
200 "OK"	Найден ответ
204 "No Content"	По переданному uid ответ не найден (не готов)
400 "Bad Request"	Ошибки валидации как тела, так и параметров запроса
401 "Unauthorized"	Отсутствует заголовок Authorization, невалидный токен для данного запроса, использование чужого или пустого сертификата и пр.
403 "Forbidden"	Запрет доступа
404 "Not Found"	Некорректный url вызова API
405 "Method Not Allowed"	Использование запрещенного HTTP метода
500 "Internal Server Error"	Внутренние ошибки сервера. Необходимо обратиться в поддержку по адресу: SKIF@sberbank.ru для проведения анализа.

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

GET https://api.sberbank.ru:8443/prod/skif/chs/v1/responses/9d80b949c362419584faeca9d8567b63
Authorization: Bearer 3d2fd034-a26b-4105-a8f6-8e8888152c7c - подставить полученный токен
RqUID: 82f1511cb0e145dda6c48ef732a14f9a

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

HTTP/1.1 200 OK
Server: nginx/1.20.1
Date: Mon, 18 Oct 2021 14:34:55 GMT
Content-Type: application/xml;charset=UTF-8
Content-Length: 7100
x-introspect-rquid: 4590f5ba5b80b0796345afc3f506d3d8
 
<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<srvGetCreditHistoryAndFraudScoreRs>
    <header>
        <rqUid>9d80b949c362419584faeca9d8567b63</rqUid>
        <rqTm>2021-03-25T09:55:29.226</rqTm>
        <SPName>urn:sbrfsystems:99-ech</SPName>
        <SCName>urn:sbrfsystems:99-portalda</SCName>
    </header>
    <response>
        <result>0</result>
        <participantsResults>
            <participantResults>
                <index>1</index>
                <fraudScoreDealResults>
                    <zone>3</zone>
                    <commentShort>short</commentShort>
                    <commentFull>full</commentFull>
                </fraudScoreDealResults>
            </participantResults>
            <participantResults>
                <index>3</index>
                <fraudScoreDealResults>
                    <zone>3</zone>
                    <commentShort>short</commentShort>
                    <commentFull>full</commentFull>
                </fraudScoreDealResults>
            </participantResults>
            <participantResults>
                <index>2</index>
                <fraudScoreDealResults>
                    <zone>2</zone>
                    <commentShort>short</commentShort>
                    <commentFull>full</commentFull>
                </fraudScoreDealResults>
            </participantResults>
        </participantsResults>
        <dealResults>
            <fraudScoreDealResults>
                <zone>3</zone>
                <commentShort>short</commentShort>
                <commentFull>full</commentFull>
            </fraudScoreDealResults>
        </dealResults>
    </response>
</srvGetCreditHistoryAndFraudScoreRs>