Andmevahetussüsteemi X-tee liides: Difference between revisions

From services.krediidiinfo.ee
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[Data_exchange_system_X-road_interface|In English]]
|}
= Tutvustus =  
= Tutvustus =  


Revision as of 12:38, 20 January 2017

Flag of the United Kingdom.svg In English


Tutvustus

POSR on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta.

Käesolev dokument kirjeldab süsteemi poolt pakutavaid teenusi X-tee vahendusel. POSR teenuste kasutamine eeldab, et osaleja on liitunud X-teega.

WSDL

POSR süsteemi WSDL asub aadressil http://services.krediidiinfo.ee/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:xrd="http://x-road.eu/xsd/xroad.xsd"
                   xmlns:id="http://x-road.eu/xsd/identifiers"
                   xmlns:posr="http://www.krediidiinfo.ee/services/posr"
                   xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd">
    <SOAP-ENV:Header>
        <xrd:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>00000000</id:memberCode>
            <id:subsystemCode>TEST</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>getCreditReport</id:serviceCode>
            <id:serviceVersion>v1</id:serviceVersion>
        </xrd:service>
        <xrd:id>test</xrd:id>
        <xrd:userId>EE00000000000</xrd:userId>
        <xrd:protocolVersion>4.0</xrd:protocolVersion>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <posr:getCreditReport>
            <rep:subject>
                <rep:ident_code>00000000000</rep:ident_code>
            </rep:subject>
            <rep:signed_consent>TEST</rep:signed_consent>
            <rep:lang>et</rep:lang>
        </posr:getCreditReport>
    </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:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                   xmlns:posr="http://www.krediidiinfo.ee/services/posr">
    <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>Test</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>getCreditReport</id:serviceCode>
            <id:serviceVersion>v1</id:serviceVersion>
        </xrd:service>
        <xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">test</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">Test</xrd:requestHash>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <posr:getCreditReportResponse>
            <credit_report xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd"
                           xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/identifiers.xsd">
		<rep:consumer_credits>
                    <rep:consumer_credit>
		        <cid:type>
                            <cid:code>CC</cid:code>
                            <cid:name>Krediitkaart</cid:name>
                        </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_payments>
                        <cid:subjects>  
			    <cid:subject>
			        <cid:ident_code>00000000000</cid:ident_code>
			        <cid:role>
                                    <cid:code>BRW</cid:code>
                                    <cid:name>Krediidivõtja</cid:name>
                                </cid:role>
			    </cid:subject>
                        </cid:subjects>
			<cid:update_datetime>2017-01-01T03:00:00</cid:update_datetime>
		    </rep:consumer_credit>
                </rep:consumer_credits>
		<rep:inquiries>
                    <rep:inquiry>
                        <cid:datetime>2017-01-02T08:17:30</cid:datetime>
                    </rep:inquiry>
		</rep:inquiries>
            </credit_report>
            <posr:fault xsi:nil="true"/>
        </posr:getCreditReportResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Teenused

Teenuste kasutamiseks peavad Osalejal olema õigused antud Creditinfo Eesti AS poolt.

generateConsent.v1

Nõusoleku dokumendi koostamine krediiditaotleja krediidikohustuste kohta andmete pärimiseks ja edastamine päringut teinud Osalejale. Nõusoleku dokument on pdf formaadis.

Päringu soap ümbriku keha parameetrid

GenerateConsentReq.png

Vastuse soap ümbriku keha parameetrid

GenerateConsentResp.png

getCreditReport.v1

Krediiditaotleja krediidikohustuste kohta andmete pärimine Osalejate andmekogudest.

Päringu soap ümbriku keha parameetrid

GetSubjectPositiveData.png

Vastuse soap ümbriku keha parameetrid

GetSubjectPositiveDataResponse.png

insertCredit.v1

Ühe tarbijakrediidi andmete registreerimine andmevahetussüsteemi andmebaasis.

Päringu soap ümbriku keha parameetrid

AddSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

AddSubjectPositiveDataResponse


updateCredit.v1

Ühe tarbijakrediidi andmete uuendamine andmevahetussüsteemi andmebaasis.

Päringu soap ümbriku keha parameetrid

UpdateSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

UpdateSubjectPositiveDataResponse


deleteCredit.v1

Ühe tarbijakrediidi andmete kustutamine andmevahetussüsteemi andmebaasist.

Päringu soap ümbriku keha parameetrid

DeleteSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

DeleteSubjectPositiveDataResponse


uploadCreditsMtom.v1

Kõigi kehtivate tarbijakrediitide andmete sisse importimine andmevahetussüsteemi andmebaasi.

Päring

Päringu sõnum 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 https://services.krediidiinfo.ee/schemas/positive_register/credit/v1/insert.xsd.


SOAP ümbriku 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:xrd="http://x-road.eu/xsd/xroad.xsd"
                   xmlns:id="http://x-road.eu/xsd/identifiers"
                   xmlns:posr="http://www.krediidiinfo.ee/services/posr">
    <SOAP-ENV:Header>
        <xrd:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>ee</id:xRoadInstance>
            <id:memberClass>COM</id:memberClass>
            <id:memberCode>00000000</id:memberCode>
            <id:subsystenCode>TEST</id:subsystenCode>
        </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>test</xrd:id>
        <xrd:userId>EE00000000000</xrd:userId>
        <xrd:protocolVersion>4.0</xrd:protocolVersion>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <posr:uploadCreditsMtom>
            <positive_data>
                <inc:Include href="cid:xxx"/>
            </positive_data>
        </posr: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

Faili töötlemise staatuse pärimine mis oli tekitatud kõigi kehtivate tarbijakrediitide andmete sisse importimise tulemusena andmevahetussüsteemi.

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>Internal service error</faultstring>
             <faultactor/>
             <detail>
                 <faultCode>-50200</faultCode>
                 <faultString>Internal service error</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äringu formaat või sisu
-50203 Access denied
Kasutajal puudub liigipääs süsteemile
-50204 Partial data
Päringu vastus sisaldab osalisi andmeid.
-50250 Credit data sync failed
Tarbijakrediidi andmete sünkroniseerimine ebaõnnestus

Lingid

Funktsionaalne spetsifikatsioon

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