Сервис «Офлайн ГБД»: различия между версиями

Версия от 05:43, 31 марта 2023

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

Краткое описание назначения сервиса: [Показать ответ]

При работе сервисов по получению сведений из ГБД возникают ситуации, когда они могут работать нестабильно или же могут быть недоступны какое-то время.

Например:

1. На стороне поставщика сервисов проводятся плановые/внеплановые технические работы, влекущие за собой их недоступность/кратковременную недоступность;

2. На стороне поставщика сервисов возникла внештатная ситуация, из-за которой сервисы недоступны или наблюдается кратковременная недоступность сервисов.

Вышеописанные ситуации негативно сказываются на своевременном получении участниками финансового рынка данных из ГБД, что влечет за собой остановку/частичную остановку определенных бизнес-процессов организации.

Целью использования данного сервиса является своевременное получение участниками финансового рынка данных, в случае возникновения внештатных или иных ситуаций, влекущих за собой недоступность сервисов ГБД. Данные в этом случае могут быть получены из кэша ГКБ, что позволит не останавливать бизнес-процессы в организации.

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

Сервис GkbHistoryDataImplService предназначен для получения данных из кэша АО «Государственное кредитное бюро» в режиме офлайн в случае недоступности сервисов ГБД. Сервис включает в себя 2 метода: getGkbHistoryId и getGkbHistoryResponse.

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

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

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:getGkbHistoryId/>  
7.	        <data:getGkbHistoryResponse/>  
8.	    </soapenv:Body>  
9.	</soapenv:Envelope>

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

Метод getGkbHistoryId сервиса GkbHistoryDataImplService

Метод getGkbHistoryId сервиса GkbHistoryDataImplService предназначен для поиска последней за кэшированной записи ответа на запрос определенного сервиса ГБД по определенному субъекту за определенный промежуток времени и получения ID данной записи в базе данных ГКБ. Состав данных запроса и ответа, а также примеры вызова метода и ответы на вызов метода представлены ниже.

Состав данных запроса метода getGkbHistoryId

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

№	Наименование	Поле	Формат	Обязательность	Примечание
1	Номер запроса	requestNumber	xs:string	Да	Значение поля должно быть уникальным и не должно повторяться при каждом запросе.
2	ИИН/БИН субъекта, по которому осуществляется поиск в кэше	iinBin	xs:string	Да	Значение должно содержать 12 цифр.
3	Наименование сервиса, в рамках которого осуществляется поиск в кэше	serviceName	xs:string	Да	Значения, которые может принимать тег serviceName смотрите в таблице 3.1.1
4	Начальная дата для поиска данных¹	DateFrom	xs:date	Да//Нет	Формат даты: ГГГГ-ММ-ДД Если тег отсутствует, а также если передано пустое значение, то по умолчанию берется дата 2022-02-02
5	Конечная дата для поиска данных¹	DateTo	xs:date	Да/Нет	Формат даты: ГГГГ-ММ-ДД Если тег отсутствует, а также если передано пустое значение, то по умолчанию берется текущая дата

– если отсутствуют оба тега в запросе, то поиск осуществляется по всей базе кэшей ГКБ в рамках указанного сервиса в теге serviceName.

Коды сервисов

Коды сервисов: [Показать ответ]

Код сервиса	Наименование сервиса	Примечание
CL_GBD_GET_LEGAL_REAL_ESTATE_REGISTER	Сервис ГБД «Регистр недвижимости ЮЛ»
CL_GBD_GET_PERSON_REAL_ESTATE_REGISTER	Сервис ГБД «Регистр недвижимости ФЛ»
CL_GBD_VERIFY_PHONE	Сервис ГБД «База мобильных граждан»
CL_GBD_FAMILY_TIES	Сервис ГБД «Верификация родственных связей»
CL_GBD_FAMILY_INFO	Сервис ГБД «Родственные связи»
CL_GBD_FAMILY_INFO_WITH_CHILD	Сервис ГБД «Родственные связи с информацией о детях»
CL_GBD_LACK_OF_AVAILABILITY_OF_PROPERTY	Сервис ГБД «Регистр недвижимости (наличие/отсутствие)»
CL_GBD_REAL_ESTATE_REGISTER_DICTIONARY	Сервис ГБД «Справочник РН»
CL_GBD_EGOV_LICENSE_SEARCH	Сервис ГБД «Е-лицензирование»
CL_GBD_FL_UL	Сервис ГБД «ФЛ/ЮЛ»

Состав данных ответа на запрос метода getGkbHistoryId

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

№	Наименование	Поле	Формат	Обязательность
Возвращаемая информация (response/responseData/data)
Статус ответа	status	xs:string	Да	Если данные найдены, то возвращается сообщение: «Запрос успешно обработан, данные найдены». Если данные не найдены, то возвращается сообщение: «Информация по данным параметрам в базе ГКБ не найдена».
Дата найденной записи в кэше	responseDate	xs:date	Да	Возвращается дата самой свежей найденной записи в кэше
ID найденной записи в кэше	responseNumber	xs:string	Да	Возвращается ID самой свежей найденной записи в кэше

Пример вызова метода getGkbHistoryId с помощью SOAP

Пример вызова метода getGkbHistoryId с помощью 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:getGkbHistoryId>  
7.	            <requestNumber>УНИКАЛЬНЫЙ_НОМЕР_ЗАПРОСА</requestNumber>  
8.	            <iin>ИИН/БИН_СУБЪЕКТА</iin>  
9.	            <serviceName>CL_GBD_FL_UL</serviceName>  
10.	            <DateFrom>2022-02-01</DateFrom>  
11.	            <DateTo>2022-02-02</DateTo>  
12.	            <consentConfirmed>true</consentConfirmed>  
13.	        </data:getGkbHistoryId>  
14.	    </soapenv:Body>  
15.	</soapenv:Envelope>

Пример ответа на вызов метода getGkbHistoryId с помощью SOAP запроса в случае, если данные в кэше найдены

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

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	    <soap:Body>  
3.	        <ns2:getGkbHistoryIdResponse 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>5a8bd0f0-8c1f-11ec-ba7a-005056a5ef49</sessionId>  
8.	                    </responseInfo>  
9.	                    <responseData>  
10.	                        <data xmlns:typ="http://bip.bee.kz/SyncChannel/v10/Types">  
11.	                            <status>Запрос успешно обработан, данные найдены</status>  
12.	                            <responseDate>2022-02-02T08:45:37.535+06:00</responseDate>  
13.	                            <responseNumber>98476</responseNumber>  
14.	                        </data>  
15.	                    </responseData>  
16.	                </response>  
17.	            </return>  
18.	        </ns2:getGkbHistoryIdResponse>  
19.	    </soap:Body>  
20.	</soap:Envelope>

Пример ответа на вызов метода getGkbHistoryId с помощью SOAP запроса в случае, если данные в кэше не найдены

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

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	    <soap:Body>  
3.	        <ns2:getGkbHistoryIdResponse 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>b87a55f0-8c20-11ec-ba7a-005056a5ef49</sessionId>  
8.	                    </responseInfo>  
9.	                    <responseData>  
10.	                        <data xmlns:typ="http://bip.bee.kz/SyncChannel/v10/Types">  
11.	                            <status>Информация по данным параметрам в базе ГКБ не найдена</status>  
12.	                            <responseDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>  
13.	                            <responseNumber xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>  
14.	                        </data>  
15.	                    </responseData>  
16.	                </response>  
17.	            </return>  
18.	        </ns2:getGkbHistoryIdResponse>  
19.	    </soap:Body>  
20.	</soap:Envelope>

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

При обработке запроса метод getGkbHistoryId может возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]

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

Главная страница

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

Версия от 05:34, 31 марта 2023 (просмотреть исходный код) Arman.Bekbosynov (обсуждение \| вклад) ← Предыдущая правка		Версия от 05:43, 31 марта 2023 (просмотреть исходный код) Arman.Bekbosynov (обсуждение \| вклад) Следующая правка →
Строка 10:		Строка 10:


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