Сервис «По предоставлению страхового отчета ОС ГПО ВТС»: различия между версиями

Версия от 06:27, 30 марта 2023

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

Описание сервиса InsuranceReport

Сервис InsuranceReport предназначен для получения сведений по страховому отчету «Обязательного страхования гражданской правовой ответственности Владельцев Транспортных Средств» (далее ОС ГПО ВТС).

Адреса web сервисов:
Тестовый сервис	https://testscbws.mkb.kz/gbdServices/InsuranceReportImplService?wsdl
Продуктивный сервис	https://scbws.mkb.kz/gbdServices/InsuranceReportImplService?wsdl
Метод сервиса:	getInsuranceReportPdf, getInsuranceReportXml

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

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

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

Http Headers: {Authorization=[Basic c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}

SOAP Message: [Показать ответ]

1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2.	      <soapenv:Header>
3.	   <userId> xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx </userId>
4.	   </soapenv:Header> 
5.	   <soapenv:Body>
6.	      <data:getInsuranceReportXml>

Состав данных запроса метода getInsurancePolicyPdf/ getInsurancePolicyXml

Состав данных запроса метода getInsurancePolicyPdf/ getInsurancePolicyXml [Показать ответ]

№	Наименование	Поле	Формат	Обязательность	Примечание
Блок входных параметров (request)
1	ИИН субъекта	request → iin	xs:string	Да	Значение должно содержать 12 цифр.
2	Язык	request → language	xs:string	Да	Получение информации на языках: kk –Казахский, ru – Русский, en – Английский
3	Тип отчета	request → reportType	xs:int	Да	Заполнить любыми цифрами
4	Имя пользователя	request → senderId	xs:int	Да	Отличительное имя пользователя
5	Пароль	request → password	xs:int	Да	Указать пароль
6	Подтверждение	request → consentConfirmed	xs:int	Да	Подтверждение субъекта

Пример вызова метода getInsuranceReportPdf с помощью SOAP запроса имеет следующий вид:

Пример вызова метода getInsuranceReportPdf с помощью SOAP запроса имеет следующий вид: [Показать ответ]

1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2.	      <soapenv:Header>
3.	   <userId>Ваш userId</userId>
4.	   </soapenv:Header> 
5.	   <soapenv:Body>
6.	      <data:getInsuranceReportPdf>
7.	          <iinBin>Иин субъекта</iinBin>
8.	         <language>указать язык</language>
9.	         <reportType>123</reportType>
10.	         <senderId> логин </senderId>
11.	         <password>пароль</password>
12.	         <consentConfirmed>согласие субъекта</consentConfirmed>
13.	      </data:getInsuranceReportPdf>
14.	   </soapenv:Body>
15.	</soapenv:Envelope>

Пример вызова метода getInsuranceReportXML с помощью SOAP запроса имеет следующий вид:

Пример вызова метода getInsuranceReportXML с помощью SOAP запроса имеет следующий вид: [Показать ответ]

1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2.	      <soapenv:Header>
3.	   <userId>xxx-xx-xxx-xxxx-xxxx-xx-xxxx</userId>
4.	   </soapenv:Header> 
5.	   <soapenv:Body>
6.	      <data:getInsuranceReportXml>
7.	         <iinBin> Иин субъекта </iinBin>
8.	         <language> указать язык </language>
9.	         <reportType>123</reportType>
10.	         <senderId> логин </senderId>
11.	         <password> пароль </password>
12.	         <consentConfirmed> согласие субъекта </consentConfirmed>
13.	      </data:getInsuranceReportXml>
14.	   </soapenv:Body>
15.	</soapenv:Envelope>

Пример успешного ответа на вызов метода getInsuranceReportPDF с помощью SOAP запроса имеет следующий вид:

Пример успешного ответа на вызов метода getInsuranceReportPDF с помощью SOAP запроса имеет следующий вид: в ответе метода getInsuranceReportPDF строка <qrCode> не предоставлен т.к оно защита внутри сгенерированного PDF файла в строке <responseResult> [Показать ответ]

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	   <soap:Body>
3.	      <ns2:getInsuranceReportPdfResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	         <return>
5.	            <response>
6.	               <responseInfo>
7.	                  <sessionId> Текущая сессия </sessionId>
8.	               </responseInfo>
9.	               <responseData>
10.	                  <data xmlns:typ="http://bip.bee.kz/SyncChannel/v10/Types">
11.	                     <status>Запрос успешно обработан, PDF сгенерирова в виде BASE64</status>
12.	                     <responseResult>Результат</responseResult>
13.	                     <qrCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
14.	                     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
15.	                        <ds:SignedInfo>
16.	                           <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
17.	                           <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34310-gost34311"/>
18.	                           <ds:Reference URI="">
19.	                              <ds:Transforms>
20.	                                 <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
21.	                                 <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"/>
22.	                              </ds:Transforms>
23.	                              <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34311"/>
24.	                              <ds:DigestValue> Ваш Сгенерированный-DigestValue </ds:DigestValue>
25.	                           </ds:Reference>
26.	                        </ds:SignedInfo>
27.	                        <ds:SignatureValue> Ваш Сгенерированный-SignatureValue </ds:SignatureValue>
28.	                        <ds:KeyInfo>
29.	                           <ds:X509Data>
30.	                              <ds:X509Certificate> Ваш Сертификат-X509Certificate </ds:X509Certificate>
31.	                           </ds:X509Data>
32.	                        </ds:KeyInfo>
33.	                     </ds:Signature>
34.	                  </data>
35.	               </responseData>
36.	            </response>
37.	         </return>
38.	      </ns2:getInsuranceReportPdfResponse>
39.	   </soap:Body>
40.	</soap:Envelope>

Пример успешного ответа на вызов метода getInsuranceReportXml с помощью SOAP запроса имеет следующий вид:

Пример успешного ответа на вызов метода getInsuranceReportXml с помощью SOAP запроса имеет следующий вид: в ответе метода getInsuranceReportXml строка <qrCode> не предоставлен т.к оно защита внутри сгенерированного XML файла в строке <responseResult> [Показать ответ]

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	   <soap:Body>
3.	      <ns2:getInsurancePolicyXmlResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	         <return>
5.	            <response>
6.	               <responseInfo>
7.	                  <sessionId> Текущая сессия </sessionId>
8.	               </responseInfo>
9.	               <responseData>
10.	                  <data xmlns:typ="http://bip.bee.kz/SyncChannel/v10/Types">
11.	                     <status>Запрос успешно обработан</status>
12.	                     <responseResult></responseResult>
13.	                     <qrCode></qrCode>
14.	                     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
15.	                        <ds:SignedInfo>
16.	                           <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
17.	                           <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34310-gost34311"/>
18.	                           <ds:Reference URI="">
19.	                              <ds:Transforms>
20.	                                 <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
21.	                                 <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"/>
22.	                              </ds:Transforms>
23.	                              <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34311"/>
24.	                              <ds:DigestValue> Ваш Сгенерированный-DigestValue </ds:DigestValue>
25.	                           </ds:Reference>
26.	                        </ds:SignedInfo>
27.	                        <ds:SignatureValue> Ваш Сгенерированный-SignatureValue </ds:SignatureValue>
28.	                        <ds:KeyInfo>
29.	                           <ds:X509Data>
30.	                              <ds:X509Certificate> Ваш Сертификат-X509Certificate </ds:X509Certificate>
31.	                           </ds:X509Data>
32.	                        </ds:KeyInfo>
33.	                     </ds:Signature>
34.	                  </data>
35.	               </responseData>
36.	            </response>
37.	            <gbdStatusResponse xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
38.	         </return>
39.	      </ns2:getInsurancePolicyXmlResponse>
40.	   </soap:Body>
41.	</soap:Envelope>

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если не заполнено обязательное поле ИИН, имеет следующий вид:

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если не заполнено обязательное поле ИИН, имеет следующий вид: [Показать ответ]

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>

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если отсутствует права пользователя, имеет следующий вид:

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если отсутствует права пользователя, имеет следующий вид: [Показать ответ]

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	   <soap:Body>
3.	      <soap:Fault>
4.	         <faultcode>soap:Server</faultcode>
5.	         <faultstring>Пользователь xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx не имеет прав для выполнения действия</faultstring>
6.	         <detail>
7.	            <ns2:ScbException xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
8.	               <faultCode>SBF-AD-1</faultCode>
9.	            </ns2:ScbException>
10.	         </detail>
11.	      </soap:Fault>
12.	   </soap:Body>
13.	</soap:Envelope>

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если отсутствует обязательное поле, имеет следующий вид:

Пример ответа на вызов метода InsuranceReport с помощью SOAP запроса в случае, если отсутствует обязательное поле, имеет следующий вид: [Показать ответ]

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	   <soap:Body>
3.	      <soap:Fault>
4.	         <faultcode>soap:Server</faultcode>
5.	         <faultstring> " Обязательное поле " отсутствует</faultstring>
6.	         <detail>
7.	            <ns2:ScbException xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
8.	               <faultCode>VAL-JSR-001</faultCode>
9.	            </ns2:ScbException>
10.	         </detail>
11.	      </soap:Fault>
12.	   </soap:Body>
13.	</soap:Envelope>

Обработка исключений метода InsurancePolicy

Код/Текст ошибки/сообщения	Описание ошибки/сообщения	Примечание
SBF-AD-1	Пользователь %s не имеет прав для выполнения действия
SBF-VE-8	Номер "ИИН" должен содержать 12 цифр
VAL-JSR-001	Значение обязательного поля "%s" не должно быть пустым
VAL-JSR-001	Обязательное поле "%s" отсутствует
VAL-R-003	Для получение отчета необходимо подтвердить согласие субъекта на запрос его кредитной истории

@@ Строка 17: / Строка 17: @@
 {| class="wikitable"
 |-
-! style="text-align: center;" |'''Наименование вышестоящего элемента'''
+! style="text-align: center;" |'''Адреса web сервисов:'''
-! style="text-align: center;" |'''Наименование элемента'''
+! style="text-align: center;" |
-! style="text-align: center;" |'''Тип'''
-!'''Размерность'''
-! style="text-align: center;" |'''Описание'''
 |-
-| style="text-align: left;" |
+| style="text-align: left;" | Тестовый сервис
-| style="text-align: left;" |
+| style="text-align: left;" | https://testscbws.mkb.kz/gbdServices/InsuranceReportImplService?wsdl
-| style="text-align: left;" |
-|
-| style="text-align: left;" |
 |-
-| style="text-align: left;" |
+| style="text-align: left;" | Продуктивный сервис
-| style="text-align: left;" |
+| style="text-align: left;" | https://scbws.mkb.kz/gbdServices/InsuranceReportImplService?wsdl
-| style="text-align: left;" |
-|
-| style="text-align: left;" |
 |-
-| style="text-align: left;" |
+| style="text-align: left;" | '''Метод сервиса:'''
-| style="text-align: left;" |
+| style="text-align: left;" | getInsuranceReportPdf, getInsuranceReportXml
-| style="text-align: left;" |
-|
-| style="text-align: left;" |
 |}
 При вызове веб-сервиса обязательно указываются следующие параметры:
-. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентифи¬кации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.
+. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентификации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.
 . ID пользователя, от имени которого будет выполнена запрашиваемая операция в SOAP Header:
@@ Строка 77: / Строка 65: @@
 {| class="wikitable"
 |-
-! style="text-align: center;" |'''Наименование вышестоящего элемента'''
+!'''№'''
-! style="text-align: center;" |'''Наименование элемента'''
+! style="text-align: center;" |'''Наименование'''
-! style="text-align: center;" |'''Тип'''
+! style="text-align: center;" |'''Поле'''
-!'''Размерность'''
+! style="text-align: center;" |'''Формат'''
-! style="text-align: center;" |'''Описание'''
+!'''Обязательность'''
+! style="text-align: center;" |'''Примечание'''
+|-
+| colspan="6" |''Блок  входных параметров''
+''(request)''
+|-
+|1
+| style="text-align: left;" | ИИН субъекта
+| style="text-align: left;" | request ''→'' iin
+| style="text-align: left;" | xs:string
+|Да
+| style="text-align: left;" | Значение должно  содержать 12 цифр.
+|-
+|2
+| style="text-align: left;" | Язык
+| style="text-align: left;" | request ''→'' language
+| style="text-align: left;" | xs:string
+|Да
+| style="text-align: left;" | Получение  информации на языках: kk –Казахский, ru  – Русский, en – Английский
 |-
-| style="text-align: left;" |
+|3
-| style="text-align: left;" |
+|Тип  отчета
-| style="text-align: left;" |
+|request ''→'' reportType
-|
+|xs:int
-| style="text-align: left;" |
+|Да
+|Заполнить любыми  цифрами
+|-
+|4
+|Имя  пользователя
+|request ''→'' senderId
+|xs:int
+|Да
+|Отличительное имя  пользователя
 |-
-| style="text-align: left;" |
+|5
-| style="text-align: left;" |
+|Пароль
-| style="text-align: left;" |
+|request ''→'' password
-|
+|xs:int
-| style="text-align: left;" |
+|Да
+|Указать пароль
 |-
-| style="text-align: left;" |
+|6
-| style="text-align: left;" |
+|Подтверждение
-| style="text-align: left;" |
+|request ''→'' consentConfirmed
-|
+|xs:int
-| style="text-align: left;" |
+|Да
+|Подтверждение  субъекта
 |}
@@ Строка 372: / Строка 389: @@
 {| class="wikitable"
 |-
-! style="text-align: center;" |'''Наименование вышестоящего элемента'''
+! style="text-align: center;" |'''Код/Текст ошибки/сообщения'''
-! style="text-align: center;" |'''Наименование элемента'''
+! style="text-align: center;" |'''Описание ошибки/сообщения'''
-! style="text-align: center;" |'''Тип'''
+! style="text-align: center;" |'''Примечание'''
-!'''Размерность'''
-! style="text-align: center;" |'''Описание'''
 |-
+| style="text-align: left;" | SBF-AD-1
+| style="text-align: left;" | Пользователь %s  не имеет прав для выполнения действия
 | style="text-align: left;" |
+|-
+| style="text-align: left;" | SBF-VE-8
+| style="text-align: left;" | Номер  "ИИН" должен содержать 12 цифр
 | style="text-align: left;" |
-| style="text-align: left;" |
+|-
-|
+| style="text-align: left;" | VAL-JSR-001
+| style="text-align: left;" | Значение  обязательного поля "%s" не должно  быть пустым
 | style="text-align: left;" |
 |-
-| style="text-align: left;" |
+|VAL-JSR-001
-| style="text-align: left;" |
+|Обязательное  поле "%s" отсутствует
-| style="text-align: left;" |
 |
-| style="text-align: left;" |
 |-
-| style="text-align: left;" |
+|VAL-R-003
-| style="text-align: left;" |
+|Для получение  отчета необходимо подтвердить согласие субъекта на запрос его кредитной  истории
-| style="text-align: left;" |
 |
-| style="text-align: left;" |
 |}