Сервис «Цифровые документы»: различия между версиями

Материал из Wiki ГКБ
Перейти к навигации Перейти к поиску
 
(не показаны 3 промежуточные версии этого же участника)
Строка 2: Строка 2:
 
{| width="auto" cellspacing="0" cellpadding="2" style="border:none;"
 
{| width="auto" cellspacing="0" cellpadding="2" style="border:none;"
 
| width="auto" valign="top"|
 
| width="auto" valign="top"|
−
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://test-wiki.mkb.kz/ Главная страница]</span>
+
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://wiki.mkb.kz/ Главная страница]</span>
 
|
 
|
−
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://test-wiki.mkb.kz/w/%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B_%D0%93%D0%91%D0%94 Предыдущая страница]</span>
+
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://wiki.mkb.kz/w/%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2_%D0%93%D0%91%D0%94 Предыдущая страница]</span>
 
|}
 
|}
 
</center>
 
</center>
Строка 865: Строка 865:
 
<div class="mw-customtoggle-myFAQ_DownloadPackagesGeneralIssues_Question_0017" style="background:#FFFFFF; border:1px solid #FFFFFF; color:#000000; padding-bottom:1px; padding-top:1px; padding-right:10px; padding-left:10px;">''При обработке запроса метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl может возвращать следующие виды ошибок/исключений/сообщений:''<small style="color:#0645ad;"> [Показать ответ] </small></div>
 
<div class="mw-customtoggle-myFAQ_DownloadPackagesGeneralIssues_Question_0017" style="background:#FFFFFF; border:1px solid #FFFFFF; color:#000000; padding-bottom:1px; padding-top:1px; padding-right:10px; padding-left:10px;">''При обработке запроса метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl может возвращать следующие виды ошибок/исключений/сообщений:''<small style="color:#0645ad;"> [Показать ответ] </small></div>
 
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myFAQ_DownloadPackagesGeneralIssues_Question_0017" style="padding:10px">
 
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myFAQ_DownloadPackagesGeneralIssues_Question_0017" style="padding:10px">
−
 
−
При обработке запроса метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl может возвращать следующие виды ошибок/исключений/сообщений:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Строка 906: Строка 904:
 
{| width="auto" cellspacing="0" cellpadding="2" style="border:none;"
 
{| width="auto" cellspacing="0" cellpadding="2" style="border:none;"
 
| width="auto" valign="top"|
 
| width="auto" valign="top"|
−
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://test-wiki.mkb.kz/ Главная страница]</span>
+
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://wiki.mkb.kz/ Главная страница]</span>
 
|
 
|
−
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://test-wiki.mkb.kz/w/%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B_%D0%93%D0%91%D0%94 Предыдущая страница]</span>
+
| style="border-bottom:5px solid #20B2AA;font:110% Arial, Helvetica, sans-serif; color: #000000;text-align:center; padding-left:15px; padding-right:15px;" |<span class="plainlinks">[https://wiki.mkb.kz/w/%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2_%D0%93%D0%91%D0%94 Предыдущая страница]</span>
 
|}
 
|}
 
</center>
 
</center>
 
<br/>
 
<br/>

Текущая версия от 04:07, 3 апреля 2023

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



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


Краткое описание работы с сервисами по предоставлению цифровых документов

Получение документов физического лица в цифровом формате производится в несколько шагов:

1. Создание/обновление профиля субъекта физического лица в «Базе мобильных граждан» (см. описание шага 1 в разделе «Метод getOnlineAccess сервиса OnlineAccessImplService»);

2. Получение согласия субъекта физического лица на предоставление доступа к его цифровым документам посредством отправки SMS сообщения на мобильный телефон субъекта и получения в ответе уникального кода (см. описание шага 2 в разделе «Метод getOnlineAccess сервиса OnlineAccessImplService»);

3. Получение цифрового документа субъекта физического лица в цифровом виде, закодированного в формате BASE64 (см. раздел «Описание сервиса DigitalDocumentsServiceImpl»).


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

Сервис OnlineAccessImplService предназначен для создания/обновления профиля субъекта физического лица в «Базе мобильных данных», а также для получения согласия субъекта на предоставление доступа к цифровым документам (шаги 1 и 2, описанные в разделе «Краткое описание работы с сервисами по предоставлению цифровых документов»).

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


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

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

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

Http Headers: {Authorization=[Basic Отличительное имя пользователя]

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:getOnlineAccess/>
7.	 </soapenv:Body>
8.	</soapenv:Envelope>

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


Метод getOnlineAccess сервиса OnlineAccessImplService

Метод getOnlineAccess сервиса OnlineAccessImplService предназначен как для создания или обновления профиля субъекта физического лица в «Базе мобильных данных», так и для получения согласия субъекта на предоставление доступа к цифровым документам. Различие только в теле запроса. Состав данных запроса и ответа, а также примеры вызова метода и ответы на вызов метода представлены ниже.


Шаг 1. Состав данных запроса для создания/обновления профиля субъекта [Показать ответ]
№ Наименование Поле Формат Обяза­тельность Примечание
1 Номер запроса requestNumber xs:string Да Значение поля должно быть уникальным и не должно повторяться при каждом запросе.
2 Ключ свойства key xs:int Да Передается значение method.
3 Значение свойства value xs:int Да Передается значение PROFILE.
4 ИИН субъекта iin xs:string Да Значение должно со­держать 12 цифр.
5 Согласие субъекта consentConfirmed xs:string Да Возможные значения:

- true;

- false.

Шаг 1. Состав данных ответа на запрос по созданию/обновлению профиля субъекта [Показать ответ]
№ Наименование Поле Формат Обяза­тельность Примечание
Возвращаемая информация

(response/responseData/data)

1 Код статуса code xs:string Да Коды вариантов ответа и их расшифровка:


PROFILE_UPDATED - Профиль обновлен

PROFILE_CREATED - Профиль создан

PROFILE_DIGIDOCS_INTERNAL_ERROR - Неизвестная ошибка

PROFILE_REQUEST_RECEIVED - Запрос успешно принят

PROFILE_ERROR_PROPERTIES - Ошибки запроса, тег apiKey или method пустой

PROFILE_NOT_FOUND - Профиль по ИИН не найден

PROFILE_DOCUMENT_TYPE_BLANK - Тип документа пустой

PROFILE_DOCUMENT_ACCESS_SUCCESS - Профиль success

PROFILE_CHILDREN_SUCCESS - Список детей успешно отработан

PROFILE_CHILD_DOCUMENT_ACCESS_SUCCESS = Запрос по ребенку прошел успешно

PROFILE_CHILD_NOT_FOUND - Не найден ребенок по ID

Пример вызова метода getOnlineAccess для создания/обновления профиля субъекта физического лица с помощью 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>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4.	 </soapenv:Header>
5.	 <soapenv:Body>
6.	  <data:getOnlineAccess>
7.	   <requestNumber>НОМЕР_ЗАПРОСА</requestNumber>
8.	   <key>method</key>
9.	   <value>PROFILE</value>
10.	   <iin>000000000000</iin>
11.	   <consentConfirmed>true</consentConfirmed>
12.	  </data:getOnlineAccess>
13.	 </soapenv:Body>
14.	</soapenv:Envelope>
Пример ответа на вызов метода getOnlineAccess для создания/обновления профиля субъекта физического лица с помощью SOAP запроса имеет следующий вид: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	   <soap:Body>
3.	      <ns2:getOnlineAccessResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	         <return>
5.	            <response>
6.	               <responseInfo>
7.	                  <messageId>393c9780-32e3-11ec-ad7b-005056a547cf</messageId>
8.	                  <correlationId/>
9.	                  <responseDate>2021-10-22T08:53:24.573+06:00</responseDate>
10.	                  <status>
11.	                     <code>1</code>
12.	                     <message>Успешно</message>
13.	                  </status>
14.	                  <sessionId>{4973a160-cc6f-4b22-a570-bcb12a470eca}</sessionId>
15.	               </responseInfo>
16.	               <responseData>
17.	                  <data xsi:type="ns3:ProfileResponse" xmlns:ns2="http://bip.bee.kz/SyncChannel/v10/Types" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Interfaces" xmlns:ns4="http://digilocker.gov.kz/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
18.	                     <code>PROFILE_REQUEST_RECEIVED</code>
19.	                     <message>Request received</message>
20.	                  </data>
21.	               </responseData>
22.	            </response>
23.	         </return>
24.	      </ns2:getOnlineAccessResponse>
25.	   </soap:Body>
26.	</soap:Envelope>

Примечание: в случае, если для субъекта не был ранее заведен профиль в «Базе мобильных граждан», то после вызова метода getOnlineAccess субъекту приходит SMS сообщение на мобильный телефон со следующим текстом: «Вы новый пользователь) поздравляем!». Если же профиль субъекта имеется в «Базе мобильных граждан», то SMS сообщение субъекту не направляется.

Шаг 2. Состав данных запроса для получения согласия субъекта на предоставление доступа к цифровым документам [Показать ответ]
№ Наименование Поле Формат Обяза­тельность Примечание
1 Номер запроса requestNumber xs:string Да Значение поля должно быть уникальным и не должно повторяться при каждом запросе.
2 Ключ свойства key xs:int Да Передается значение method.
3 Значение свойства value xs:int Да Передается значение ACCESS-DOCUMENT.
4 ИИН субъекта iin xs:string Да Значение должно со­держать 12 цифр.
5 Вид документа documentType xs:string Да Список документов смотрите в таблице «Виды документов».
6 Согласие субъекта на запрос по нему consentConfirmed xs:string Да Возможные значения:

- true;

- false.

Таблица «Виды документов» [Показать ответ]
Код типа документа Наименование документа на государственном языке Наименование документа на русском языке Государственный орган
IdentityCard Жеке куәлік Удостоверение личности МВД РК, Отдел документирования
DriverLicense Жүргізуші куәлігі Водительское удостоверение МВД РК
BirthCertificate Туу туралы куәлік Свидетельство о рождении МЮ РК
MarriageCertificate Неке қию туралы куәлік Свидетельство о заключении брака МЮ РК
ChangeFioCertificate Тегін, атын, әкесінің атын өзгерту туралы куәлік Свидетельство о перемене фамилии, имени, отчества МЮ РК
DivorceCertificate Некені бұзу туралы куәлік Свидетельство о расторжении брака МЮ РК
TechPassport Техникалық паспорт Технический паспорт МЮ РК
PcrCertificate COVID-19-ға тестілеу бойынша ПТР нәтижесі Результат ПЦР тестирования на COVID-19 МЗ РК
StudentCard Студенттік билет Студенческий билет МОН РК
Diploma Диплом Диплом МОН РК
Pension Зейнеткер куәлігі Удостоверение пенсионера МТСЗН РК
Oralman Қандас куәлігі Удостоверение кандаса МТСЗН РК
SRTS Көлік құралын тіркеу туралы куәлік Свидетельство о регистрации транспортного средства МВД РК
SocialId Әлеуметтік ID Социальный ID МТСЗН РК
Vaccination Вакцинация паспорты Паспорт вакцинации МЗ РК
DisabilityCertificate Мүгетектігі бар тұлғаның куәлігі Удостоверение лица с инвалидностью МТСЗН РК
LargeFamilyCertificate Көпбалалы отбасы куәлігі Удостоверение о многодетной семье МТСЗН РК
AspCertificate Удостоверение получателя АСП МТСЗН РК
Шаг 2. Состав данных ответа на запрос по получению согласия субъекта на предоставление доступа к цифровым документам [Показать ответ]
№ Наименование Поле Формат Обяза­тель­ность Примечание
1 Код статуса code xs:string Да Коды возвращаемых ответов и их расшифровка:


PROFILE_UPDATED - Профиль обновлен

PROFILE_CREATED - Профиль создан

PROFILE_DIGIDOCS_INTERNAL_ERROR - Неизвестная ошибка

PROFILE_REQUEST_RECEIVED - Запрос успешно принят

PROFILE_ERROR_PROPERTIES - Ошибки запроса, тег apiKey или method пустой

PROFILE_NOT_FOUND - Профиль по ИИН не найден

PROFILE_DOCUMENT_TYPE_BLANK - Тип документа пустой

PROFILE_DOCUMENT_ACCESS_SUCCESS - Профиль success

PROFILE_CHILDREN_SUCCESS - Список детей успешно отработан

PROFILE_CHILD_DOCUMENT_ACCESS_SUCCESS = Запрос по ребенку прошел успешно

PROFILE_CHILD_NOT_FOUND - Не найден ребенок по ID

PROFILE_DOCUMENT_TYPE_BLANK - Тип документа пустой

PROFILE_DOCUMENT_ACCESS_SUCCESS - Профиль success

PROFILE_CHILDREN_SUCCESS - Список детей успешно отработан

PROFILE_CHILD_DOCUMENT_ACCESS_SUCCESS = Запрос по ребенку прошел успешно

PROFILE_CHILD_NOT_FOUND - Не найден ребенок по ID

Пример вызова метода getOnlineAccess для получения согласия субъекта на предоставление доступа к цифровым документам с помощью 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>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4.	 </soapenv:Header>
5.	 <soapenv:Body>
6.	  <data:getOnlineAccess>
7.	   <requestNumber>НОМЕР_ЗАПРОСА</requestNumber>
8.	   <key>method</key>
9.	   <value>ACCESS-DOCUMENT</value>
10.	   <iin>000000000000</iin>
11.	   <documentType>IdentityCard</documentType>
12.	   <consentConfirmed>true</consentConfirmed>
13.	  </data:getOnlineAccess>
14.	 </soapenv:Body>
15.	</soapenv:Envelope>
Пример успешного ответа на вызов метода getOnlineAccess по получению согласия субъекта на предоставление доступа к цифровым документам с помощью SOAP запроса имеет следующий вид: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	 <soap:Body>
3.	  <ns2:getOnlineAccessResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	   <return>
5.	    <response>
6.	     <responseInfo>
7.	      <messageId>2a61d4f0-31bc-11ec-ad7b-005056a547cf</messageId>
8.	      <correlationId/>
9.	      <responseDate>2021-10-20T21:41:25.675+06:00</responseDate>
10.	      <status>
11.	       <code>0</code>
12.	       <message>Успешно</message>
13.	      </status>
14.	      <sessionId>{d0af15c4-ce53-4f6d-8837-6f82050a7022}</sessionId>
15.	     </responseInfo>
16.	     <responseData>
17.	      <data xsi:type="ns3:DocumentAccessResponse" xmlns:ns2="http://bip.bee.kz/SyncChannel/v10/Types" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Interfaces" xmlns:ns4="http://digilocker.gov.kz/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
18.	       <code>PROFILE_DOCUMENT_ACCESS_SUCCESS</code>
19.	       <message>Профиль success</message>
20.	      </data>
21.	     </responseData>
22.	    </response>
23.	   </return>
24.	  </ns2:getOnlineAccessResponse>
25.	 </soap:Body>
26.	</soap:Envelope>
Пример ошибочного ответа на вызов метода getOnlineAccess по получению согласия субъекта на предоставление доступа к цифровым документам с помощью SOAP запроса имеет следующий вид: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	 <soap:Body>
3.	  <ns2:getOnlineAccessResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	   <return>
5.	    <response>
6.	     <responseInfo>
7.	      <messageId>e666c3b0-37dc-11ec-a5b8-005056a547cf</messageId>
8.	      <correlationId/>
9.	      <responseDate>2021-10-28T16:50:48.514+06:00</responseDate>
10.	      <status>
11.	       <code>0</code>
12.	       <message>Ошибка</message>
13.	      </status>
14.	      <sessionId>{ddd99f2c-7ec3-43cf-a9f3-b45d8712a021}</sessionId>
15.	     </responseInfo>
16.	     <responseData>
17.	      <data xsi:type="ns3:ErrorResponse" xmlns:ns2="http://bip.bee.kz/SyncChannel/v10/Types" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Interfaces" xmlns:ns4="http://digilocker.gov.kz/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
18.	       <code>PROFILE_DIGIDOCS_INTERNAL_ERROR</code>
19.	       <message>Issued document not found</message>
20.	      </data>
21.	     </responseData>
22.	    </response>
23.	   </return>
24.	  </ns2:getOnlineAccessResponse>
25.	 </soap:Body>
26.	</soap:Envelope>


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

При обработке запроса метод getOnlineAccess сервиса OnlineAccessImplService может возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]
Код/Текст ошибки/сообщения Описание ошибки/сообщения Примечание
SBF-VE-8 Номер "ИИН" должен содержать 12 цифр
VAL-JSR-001 Значение обязательного поля "%s" не должно быть пустым
VAL-JSR-001 Обязательное поле "%s" отсутствует
ScbSystemFault Пользователь %s не имеет прав для вы­пол­нения действия
FAULT-015 Сервис на стороне ГБД не досту­пен
VAL-R-004 Для получения отчета необходимо подтвер­дить согласие субъекта на запрос его данных из ГБД


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

Сервис DigitalDocumentsServiceImpl предназначен для получения цифрового документа субъекта физического лица в цифровом виде в закодированном (BASE64) виде.

ВАЖНО: Вызов данного метода осуществляется после 15-ти секунд получения СМС кода.

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


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

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

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

Http Headers: {Authorization=[Basic Отличительное имя пользователя]

SOAP Message: [Показать ответ] 
9.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
10.	 <soapenv:Header>
11.	  <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
12.	 </soapenv:Header>
13.	 <soapenv:Body>
14.	  <data:getDigitalDocuments/>
15.	 </soapenv:Body>
16.	</soapenv:Envelope>

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


Метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl

Метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl предназначен для получения цифрового документа субъекта физического лица в закодированном виде. Полученный цифровой документ закодирован в формате BASE64. Состав данных запроса и ответа, а также примеры вызова метода и ответы на вызов метода представлены ниже.

Шаг 3. Состав данных запроса на получение цифрового документа субъекта [Показать ответ]
№ Наименование Поле Формат Обяза­тельность Примечание
1 Номер запроса requestNumber xs:string Да Значение поля должно быть уникальным и не должно повторяться при каждом запросе.
4 ИИН субъекта iin xs:string Да Значение должно со­держать 12 цифр.
3 Код, полученный в SMS сообщении code xs:integer Да Шестизначный код, полученный субъектом в SMS сообщении на Шаге 2.
5 Согласие субъекта consentConfirmed xs:string Да Возможные значения:

- true;

- false.

Шаг 3. Состав данных ответа на запрос по получению цифрового документа субъекта [Показать ответ]
№ Наименование Поле Формат Обяза­тельность Примечание
Возвращаемая информация

(response/responseData/data)

1 Код ответа responseCode xs:string Да
2 Сообщение ответа responseMessage xs:string Да
3 Цифровой документ в кодировке BASE64 content xs:string Да
Блок информации о типе документа

(documentType)

4 Наименование документа на русском языке nameRu xs:string Да
5 Наименование документа на государственном языке nameKk xs:string Да
6 Наименование документа на английском языке nameEn xs:string Да
7 Код типа документа code xs:string Да Смотрите таблицу «Виды документов»


Пример вызова метода getDigitalDocuments для получения цифрового документа субъекта с помощью 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>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4.	 </soapenv:Header>
5.	 <soapenv:Body>
6.	  <data:getDigitalDocuments>
7.	   <requestNumber>НОМЕР_ЗАПРОСА</requestNumber>
8.	   <iin>000000000000</iin>
9.	   <code>222222</code>
10.	   <consentConfirmed>true</consentConfirmed>
11.	  </data:getDigitalDocuments>
12.	 </soapenv:Body>
13.	</soapenv:Envelope>
Пример ответа на вызов метода getDigitalDocuments по получению цифрового документа субъекта с помощью SOAP запроса имеет следующий вид: [Показать ответ] 
1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2.	 <soap:Body>
3.	  <ns2:getDigitalDocumentsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4.	   <return>
5.	    <response>
6.	     <responseData>
7.	      <data xsi:type="ns3:DocumentResponse" xmlns:ns2="http://bip.bee.kz/SyncChannel/v10/Types" xmlns:ns3="http://digilocker.gov.kz/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
8.	       <responseCode>SUCCESS</responseCode>
9.	       <responseMessage>SUCCESS</responseMessage>                    
10.	       <content>JVBERi0xLjQKJeL ... XBvbmVu</content>
11.	       <documentType>
12.	        <nameRu>Удостоверение личности</nameRu>
13.	        <nameKk>Жеке куәлік</nameKk>
14.	        <nameEn>Identity card</nameEn>
15.	        <code>IdentityCard</code>
16.	       </documentType>
17.	      </data>
18.	     </responseData>
19.	    </response>
20.	   </return>
21.	  </ns2:getDigitalDocumentsResponse>
22.	 </soap:Body>
23.	</soap:Envelope>


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

При обработке запроса метод getDigitalDocuments сервиса DigitalDocumentsServiceImpl может возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]
Код/Текст ошибки/сообщения Описание ошибки/сообщения Примечание
SBF-VE-8 Номер "ИИН" должен содержать 12 цифр
VAL-JSR-001 Значение обязательного поля "%s" не должно быть пустым
VAL-JSR-001 Обязательное поле "%s" отсутствует
ScbSystemFault Пользователь %s не имеет прав для вы­пол­нения действия
FAULT-015 Сервис на стороне ГБД не досту­пен
VAL-R-004 Для получения отчета необходимо подтвер­дить согласие субъекта на запрос его данных из ГБД


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


Источник — https://wiki.gkb.kz/?title=Сервис_«Цифровые_документы»&oldid=6224