Сервис «По расчёту скорингового балла физического лица»: различия между версиями

Материал из Wiki ГКБ
Перейти к навигации Перейти к поиску
Строка 62: Строка 62:
  
  
−
===='''Метод getClientScore'''===
+
==='''Метод getClientScore'''===
 
----
 
----
 
Метод getClientScore возвращает скоринговый балл для указанного субъекта кредитной истории (физическое лицо).
 
Метод getClientScore возвращает скоринговый балл для указанного субъекта кредитной истории (физическое лицо).
Строка 266: Строка 266:
 
</div>
 
</div>
 
</div>
 
</div>
−
 
  
 
===Интерпретация результата Сервиса по расчету скорингового балла физического лица===
 
===Интерпретация результата Сервиса по расчету скорингового балла физического лица===

Версия от 08:43, 29 марта 2023

Главная страница Предыдущая страница


В документе описывается сервис АО «Государственное кредитное бюро» (далее - ГКБ) по расчету скорингового балла физического лица (далее - Сервис), методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки. Сервис предназначен для получения скорингового балла физического лица, получателем которого являются участники финансового рынка.


Сервис получения скорингового балла субъекта кредитной истории

Сервис предназначен для получения скорингового балла физические лица.

Адреса web сервисов:
Тестовый сервис https://testscbws.mkb.kz/scoringServices/IndividualScoringWebService?wsdl
Продуктивный сервис https://scbws.mkb.kz/scoringServices/IndividualScoringWebService?wsdl
Метод сервиса: getClientScore

При вызове веб-сервиса обязательно указываются следующие параметры:


1. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентификации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.

2. ID пользователя, от имени которого будет выполнена запрашиваемая операция в SOAP Header:

Http Headers: {Authorization=[Basic jUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}

SOAP Message: [Показать ответ] 
1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:scor="http://scoring.chdb.scb.kz">  
2.	 <soapenv:Header>  
3.	  <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>  
4.	 </soapenv:Header>  
5.	 <soapenv:Body>  
6.	  <scor:getClientScore/>  
7.	 </soapenv:Body>  
8.	</soapenv:Envelope>

где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 - есть значение HTTP Header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм Basic Authentication.


Метод getClientScore

Метод getClientScore возвращает скоринговый балл для указанного субъекта кредитной истории (физическое лицо).

Состав данных запроса на вызов метода [Показать ответ]
№ Поле Наименование Тип Обязательность Примечание
1 iin ИИН физического лица xs:string Да Значение должно содержать 12 цифр
Состав данных ответа на запрос метода [Показать ответ]
№ Поле Наименование Тип Примечание
1 score Показатели скоринговой карты xs:string
2 Rating
3 billingNumber Номер биллинга xs:string
4 billingEndDate Время запись биллинга xs:string
4 scoringType Тип скоринга xs:string


Примеры вызова и ответа на вызов метода getClientScore

В параметрах запроса передаются поисковые данные (входные параметры), по которым осуществляется поиск субъекта. Если субъект будет найден, то будет сформирован требуемый ответ. Если будет найдено несколько субъектов или требуемый субъект не будет найден, то будет сформирована ошибка. Ниже приведен пример вызова метода getClientScore, а также примеры ответа на вызов метода.

Пример запроса на вызов метода getClientScore: [Показать ответ] 
1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:scor="http://scoring.chdb.scb.kz">  
2.	 <soapenv:Header>  
3.	  <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>  
4.	 </soapenv:Header>  
5.	 <soapenv:Body>  
6.	  <scor:getClientScore>  
7.	   <IndividualScoreRequest>  
8.	    <iin>000000000000</iin>  
9.	    </IndividualScoreRequest>  
10.	  </scor:getClientScore>  
11.	 </soapenv:Body>  
12.	</soapenv:Envelope>
Пример успешного ответа на запрос метода getClientScore: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">  
3.	  <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>  
4.	  <creditorId>xxx</creditorId>  
5.	  <timestamp>1604395426772</timestamp>  
6.	 </SOAP-ENV:Header>  
7.	 <soap:Body>  
8.	  <ns2:getClientScoreResponse xmlns:ns2="http://scoring.chdb.scb.kz">  
9.	   <IndividualScoreResponse>      
10.	    <score>80</score>  
11.	     <billingNumber>26279583</billingNumber>
12.	      <billingEndDate>2022-10-07T10:17:18.257+06:00</billingEndDate>  
13.	       <scoringType>21</scoringType>
14.	     <rating>B</rating>  
15.	   </IndividualScoreResponse>  
16.	  </ns2:getClientScoreResponse>
17.	 </soap:Body>  
18.	</soap:Envelope>
Пример ответа на запрос метода getClientScore, если передать пустое значение в параметре <userId>: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>Cannot get property 'textContent' on null object</faultstring>  
7.	  </soap:Fault>  
8.	 </soap:Body>  
9.	</soap:Envelope>
Пример ответа на запрос метода getClientScore, если пользователь не найден или не зарегистрирован: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>There is no principal with id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.</faultstring>  
7.	  </soap:Fault>  
8.	 </soap:Body>  
9.	</soap:Envelope>
Пример ответа на запрос метода getClientScore, если у пользователя отсутствуют права на вызов сервиса: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>Code: SBF-AD-1. ID: ed878a49-8151-4784-9561-e68c907245ca</faultstring>  
7.	   <detail>  
8.	    <ns2:ScbBusinessFault xmlns:ns2="http://scoring.chdb.scb.kz">  
9.	     <faultCode>SBF-AD-1</faultCode>  
10.	     <faultDescription/>  
11.	     <faultId>ed878a49-8151-4784-9561-e68c907245ca</faultId>  
12.	     <faultTimestamp>2020-11-03T16:52:24.338+06:00</faultTimestamp>  
13.	     <faultType>ACCESS_DENIED</faultType>  
14.	     <placeholders>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</placeholders>  
15.	     <placeholders>?????</placeholders>  
16.	    </ns2:ScbBusinessFault>  
17.	   </detail>  
18.	  </soap:Fault>  
19.	 </soap:Body>  
20.	</soap:Envelope>

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

Интерпретация результата Сервиса по расчету скорингового балла физического лица [Показать ответ]
Диапазон Рейтинг Интерпретация
Скорбалл < =10 Е Очень низкая кредитоспособность
10 < Скорбалл <= 20
20 < Скорбалл <= 30
30 < Скорбалл <= 40 D Низкая кредитоспособность
40 < Скорбалл <= 50
50 < Скорбалл <= 60 C Средняя кредитоспособность
60 < Скорбалл <= 70
70 < Скорбалл <= 80 B Хорошая кредитоспособность
80 < Скорбалл <= 90
90 < Скорбалл A Высокая кредитоспособность


Ошибки веб-сервиса

Веб-сервис может возвращать следующие виды ошибок:

1. ScbBusinessFault

Предсказуемые ошибки, связанные, как правило, с бизнес-логикой работы ПО БДКИ. Например, проверки правил бизнес-логики, проверки безопасности, данные не найдены, и т.д.


2. ScbValidationFault
Ошибки, возникающие при проверке корректности данных. Например, нарушение правил бизнес-логики, превышение размерности данных и т.д. [Показать ответ]
Код ошибки Тип ошибки Описание ошибки Примечание
SBF-VE-8 ScbValidationFault Номер "ИИН" должен содержать 12 цифр.
VAL-JSR-001 ScbValidationFault Обязательное поле "%s" отсутствует.
SBF-AD-1 ScbBusinessFault Пользователь %s не имеет прав для выполнения действия: "%s".
SBF-IC-1 ScbBusinessFault Ошибка в процессе генерации отчета. Более одного субъ­екта найдено по данному запросу.
Примеры ошибок ScbValidationFault [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>Ошибки:</faultstring>  
7.	   <detail>  
8.	    <ns2:ValidationFault xmlns:ns2="http://scoring.chdb.scb.kz">  
9.	     <constraintViolations>  
10.	      <code>VAL-JSR-001</code>  
11.	      <description>Обязательное поле "иин" отсутствует.</description>  
12.	      <placeholders>ИИН</placeholders>  
13.	     </constraintViolations>  
14.	    </ns2:ValidationFault>  
15.	   </detail>  
16.	  </soap:Fault>  
17.	 </soap:Body>  
18.	</soap:Envelope>
Пример ошибки ScbBusinessFault [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>Code: SBF-IC-1. ID: 3c4d82f1-42dd-47c2-a0ab-ba855cb1e9d7</faultstring>  
7.	   <detail>  
8.	    <ns2:ScbBusinessFault xmlns:ns2="http://scoring.chdb.scb.kz">  
9.	     <faultCode>SBF-IC-1</faultCode>  
10.	     <faultDescription>Ошибка в процессе генерации отчета. Более одного субъекта найдено по данному запросу.</faultDescription>  
11.	     <faultId>3c4d82f1-42dd-47c2-a0ab-ba855cb1e9d7</faultId>  
12.	     <faultTimestamp>2020-11-03T18:30:53.389+06:00</faultTimestamp>  
13.	     <faultType>INTEGRITY_CHECK</faultType>  
14.	    </ns2:ScbBusinessFault>  
15.	   </detail>  
16.	  </soap:Fault>  
17.	 </soap:Body>  
18.	</soap:Envelope>


ScbSystemFault

Непредвиденные ошибки, которые могут возникнуть при работе ПО БДКИ. Например, ошибки подключения к каким-то ресурсам, сетевые ошибки, ошибки недостаточности памяти и т.д.

Наименование Тип Описание
faultCode xs:string Код ошибки
faultDescription xs:string Описание ошибки
faultId xs:string Уникальный идентификатор ошибки
faultTimestamp xs:dateTime Дата, время ошибки
faultType xs:string Тип ошибки

ScbSystemFault:

PROGRAMMATIC_ERROR

SOAP Message: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>  
3.	 <soap:Body>  
4.	  <soap:Fault>  
5.	   <faultcode>soap:Server</faultcode>  
6.	   <faultstring>TsbScoreBizServiceImpl.getScore. ID: db7f4ac1-d438-4d8c-b239-6e49fb18c2c2</faultstring>  
7.	   <detail>  
8.	    <ns2:ScbSystemFault xmlns:ns2="http://scoring.chdb.scb.kz">  
9.	     <faultCode>TsbScoreBizServiceImpl.getScore</faultCode>  
10.	     <faultDescription>Contact system's administrator and provide the fault code and IDAn Authentication object was not found in the SecurityContext</faultDescription>  
11.	     <faultId>db7f4ac1-d438-4d8c-b239-6e49fb18c2c2</faultId>  
12.	     <faultTimestamp>2020-11-03T16:42:06.585+06:00</faultTimestamp>  
13.	     <faultType>PROGRAMMATIC_ERROR</faultType>  
14.	    </ns2:ScbSystemFault>  
15.	   </detail>  
16.	  </soap:Fault>  
17.	 </soap:Body>  
18.	</soap:Envelope>
Источник — https://wiki.gkb.kz/?title=Сервис_«По_расчёту_скорингового_балла_физического_лица»&oldid=5966