Andmevahetussüsteemi X-tee liides

From services.krediidiinfo.ee
Revision as of 14:20, 6 December 2016 by Paavo (talk | contribs)
Jump to navigation Jump to search

Tutvustus

KRI6 on Creditinfo liides, mille vahendusel Osalejad vahetavad krediiditaotleja krediidikohustuste andmeid omavahel X-tee versioon 6 vahendusel. See spetsifikatsioon kirjeldab andmete vahetuse tehnilisi aspekte. KRI6 teenuste kasutamine eeldab, et osaleja on liitunud X-teega.

WSDL

POSR alamsüsteemi WSDL asub aadresslil https://services.krediidiinfo.ee/wsdl/posr.wsdl.

X-tee sõnum

X-tee päring on vastavalt teenuse kirjeldusele kas

  • SOAP ümbrik
  • või on MIME multipart/related stiilis, mille esimeses osas on SOAP ümbrik.

Vastus on SOAP ümbrik.

SOAP ümbrik koosneb päisest ja kehast.

SOAP ümbriku päis

SOAP ümbriku päises oleva info koosseis on määratud X-tee spetsifikatsiooni poolt.

SOAP ümbriku keha

SOAP ümbriku kehas oleva info koosseis on määratud käesoleva dokumendi poolt.

Päringu soap ümbriku näide

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kri="http://posr.x-road.eu">
    <SOAP-ENV:Header>
        <xrd:client id:objectType="MEMBER" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>00000000</id:memberCode>
            <id:subsystemCode>XX</id:subsystemCode>
        </xrd:client>
        <xrd:service id:objectType="SERVICE" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>10256137</id:memberCode>
            <id:subsystemCode>POSR</id:subsystemCode>
            <id:serviceCode>getSubjectData</id:serviceCode>
            <id:serviceVersion>v1</id:serviceVersion>
        </xrd:service>
        <xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">5734440e50c71</xrd:id>
        <xrd:userId xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">EE00000000000</xrd:userId>
        <xrd:issue xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"/>
        <xrd:protocolVersion xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">4.0</xrd:protocolVersion>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
       <kri:getSubjectData>
            <subject>
                <ident_code>00000000000</ident_code>
            </subject>
            <is_digi_agreement>1</is_digi_agreement>
            <lang>en</lang>
        </kri:getSubjectData>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Vastuse soap ümbriku näide

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kri="http://posr.x-road.eu">
    <SOAP-ENV:Header>
        <xrd:client id:objectType="MEMBER" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>00000000</id:memberCode>
            <id:subsystemCode>XX</id:subsystemCode>
        </xrd:client>
        <xrd:service id:objectType="SERVICE" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>10256137</id:memberCode>
            <id:subsystemCode>POSR</id:subsystemCode>
            <id:serviceCode>getSubjectData</id:serviceCode>
            <id:serviceVersion>v1</id:serviceVersion>
        </xrd:service>
        <xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">5734440e50c71</xrd:id>
        <xrd:userId xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">EE00000000000</xrd:userId>
        <xrd:issue xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"/>
        <xrd:protocolVersion xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">4.0</xrd:protocolVersion>
        <xrd:requestHash algorithmId="http://www.w3.org/2001/04/xmlenc#sha512">
            RglGFiBmbZJ0JLwm+vzfGn4fQEIY1YfM81H3SekOw5VnwxO/jilTfHG0zgsaUH9LzLOCqb5YssDz0MbMzm3DhQ==
        </xrd:requestHash>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <kri:getSubjectDataResponse>
            <subject_positive_data>
                <consumer_credits xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit_identifiers.xsd">
		    <consumer_credit>
			<cid:type code="O">Other</cid:type>
			<cid:begin_date>2016-07-14</cid:begin_date>
			<cid:end_date>2017-07-14</cid:end_date>
			<cid:sum>200</cid:sum>
			<cid:balance>200</cid:balance>
			<cid:unpaid_sum>7</cid:unpaid_sum>
			<cid:currency>EUR</cid:currency>
			<cid:schedule_payments>
			    <cid:schedule_payment>
				<cid:due_date>2016-10-22</cid:due_date>
				<cid:sum>100.0</cid:sum>
			    </cid:schedule_payment>
			    <cid:schedule_payment>
				<cid:due_date>2017-01-30</cid:due_date>
				<cid:sum>100.0</cid:sum>
			    </cid:schedule_payment>
			</cid:schedule_payments>
			<cid:subject>
			    <cid:ident_code>48508060269</cid:ident_code>
			    <cid:role code="GRT">Guarantor</cid:role>
			</cid:subject>
			<cid:update_datetime>1970-01-01T03:00:00</cid:update_datetime>
		    </consumer_credit>
		</consumer_credits>
		<requests xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit_identifiers.xsd">
		    <request>
			<cid:datetime>2016-08-10T09:01:38</cid:datetime>
		    </request>
		    <request>
			<cid:datetime>2016-08-15T09:55:56</cid:datetime>
		    </request>
		</requests>
           </subject_positive_data>
           <fault xsi:nil="true"/>
        </kri:getSubjectDataResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Teenused

getSubjectData.v1

Krediiditaotleja andmete pärimine Osalejate andmekogudest.

Päringu soap ümbriku keha parameetrid

GetSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

GetSubjectPositiveDataResponse


addCredit.v1

Ühe tarbijakrediidi andmete registreerimine.

Päringu soap ümbriku keha parameetrid

AddSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

AddSubjectPositiveDataResponse


updateCredit.v1

Ühe tarbijakrediidi andmete uuendamine.

Päringu soap ümbriku keha parameetrid

UpdateSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

UpdateSubjectPositiveDataResponse


deleteCredit.v1

Ühe tarbijakrediidi andmete kustutamine.

Päringu soap ümbriku keha parameetrid

DeleteSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

DeleteSubjectPositiveDataResponse


uploadCreditsMtom.v1

Kõigi kehtivate tarbijakrediitide andmete sisseimportimine.

Päring

Päring on MTOM/XOP formaadis, mis vastab SOAP multipart/related standardile. Sõnumi esimeses osas on SOAP ümbrik. Sõnumi teises osas on gzip-ga kokkupakkitud ja seejärel base64-ga kodeeritud tarbijakrediitide andmetega xml, mis vastab skeemile http://www.krediidiinfo.ee/schemas/positive_register/data_exchange.xsd.


SOAP ümbriku keha parameetrid on:

UploadPositiveDataMtom


Loaninfo debtors.png


Näitepäring: 

...Teised päised
Content-Type: multipart/related; type="application/xop+xml"; start="<xxx>"; start-info="text/xml"; boundary="MIME_boundary"'
MIME-Version: 1.0

--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <xxx>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="http://posr.x-road.eu"
    xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
    xmlns:id="http://x-road.eu/xsd/identifiers"
    xmlns:inc="http://www.w3.org/2004/08/xop/include">
<SOAP-ENV:Header>
    <xrd:client id:objectType="MEMBER">
        <id:xRoadInstance>ee</id:xRoadInstance>
        <id:memberClass>COM</id:memberClass>
        <id:memberCode>00000000</id:memberCode>
        <id:subsystemCode>XX</id:subsystemCode>
    </xrd:client>
    <xrd:service id:objectType="SERVICE">
        <id:xRoadInstance>ee</id:xRoadInstance>
        <id:memberClass>COM</id:memberClass>
        <id:memberCode>10256137</id:memberCode>
        <id:subsystemCode>POSR</id:subsystemCode>
        <id:serviceCode>uploadCreditsMtom</id:serviceCode>
        <id:serviceVersion>v1</id:serviceVersion>
    </xrd:service>
    <xrd:id>4894e35d-bf0f-44a6-867a-8e51f1daa7e0</xrd:id>
    <xrd:userId>EE00000000000</xrd:userId>
    <xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
    <ns1:uploadCreditsMtom>
        <positive_data>
            <inc:Include href="cid:xxx"/>
        </positive_data>
    </ns1:uploadCreditsMtom>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

--MIME_boundary
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64
Content-ID: <xxx>
Content-Disposition: attachment;

H4sIAAAAAAAAA12PsW7CQAyGd6S+Q+Q9dxeoRIkIbEx0KpXYoujOCRbEh84uyeM3abtQyfLi///kb7sf+1v2wCQUuYLCOMiQfQzEXQWfp0P+Bvvdy2LrI8tXj6n2CQOpZFOPpaRQwUX1Xlo7DIO5zkeahttoEK34C/aN2HsUUnpgnbAjUUz2F1NTQFZqaXrAjBLgDzsKPXGHlYmps0vnCnt+P378YHNi0YY9QtYhY2oU6zAtpR4rmLN5scyL9cltypUrX9cwi9j/Jrtv1xHpQQQBAAA=


--MIME_boundary--

Vastuse soap ümbriku keha parameetrid

UploadPositiveDataMtomResponse

getUploadStatus.v1

Üleslaetud kõigi kehtivate tarbijakrediitide andmete alusel tekitatud faili töötlemise staatuse pärimine.

Päringu soap ümbriku keha parameetrid

UploadPositiveDataStatus


Vastuse soap ümbriku keha parameetrid

UploadPositiveDataStatusResponse

Tehniline viga

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Body>
		<SOAP-ENV:Fault>
			<faultcode>SOAP-ENV:Server</faultcode>
			<faultstring>Veateade</faultstring>
			<faultactor/>
			<detail>
				<faultCode>0</faultCode>
				<faultString>Veateade</faultString>
			</detail>
		</SOAP-ENV:Fault>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Veakoodid

-50200 Unknown error
Tundmatu viga
-50201 Internal error
Serverisse tekkis sisemine viga
-50202 Invalid request
Vigane päring
-50203 Access denied
Puudub liigipääs süsteemile
-50204 Partial data
Päringu vastus sisaldab osalisi andmeid.


Lingid

Funktsionaalne spetsifikatsioon

Retrieved from "https://services.krediidiinfo.ee/wiki/index.php?title=Andmevahetussüsteemi_X-tee_liides&oldid=799"