Positiivne register: funktsionaalne spetsifikatsioon: 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"
{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[Positive_register:_functional_specification|In English]]
| [[Image:Flag of the United Kingdom.png|border|30px]] [[Data_exchange_system_X-road_interface|In English]]
|}
|}


= Tutvustus =


= Sissejuhatus =
'''POSR''' on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta.  
'''Positiivne Register''' on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta. Positiivne Register võimaldab laenuandjal täita seadusest tulenevat vastutustundliku laenamise nõuet ning veenduda inimese võimes täita oma laenukohustust. Laenuklient ei pea enam tooma paberkandjal väljavõtteid teiste laenuandjate juurest ning on paremini kaitstud emotsionaalsete laenuotsuste ja ülelaenamisest tekkivate probleemide eest.


Käesolev dokument kirjeldab süsteemi poolt pakutavaid teenusi X-tee vahendusel.


= Mõisted =
= Teenuste kasutamine toodangukeskkonnas =
POSR süsteemi teenuste kasutamine eeldab, et osaleja on liitunud X-teega, paigaldanud ja seadistanud x-tee tervaserverit ning saanud liigipääsuõigused teenustele Creditinfolt.


* '''Andmed''' – andmed tarbija olemasolevate kohustuste kohta, mis võimaldavad Osalejal hinnata tarbija krediidivõimelisust;
Päringu edastamiseks toodangukkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "EE" ning saata päringu toodang x-tee turvaserverisse.
* '''Andmevahetussüsteem''' (''Data exchange system '') – infotehniline rakendus, mille vahendusel Osalejad vahetavad Andmeid;
* '''Andmevahetussüteemi haldaja''' (''Data exchange system manager'') – Creditinfo Eesti AS;
* '''Krediiditaotleja''' (''consumer'') - eraisik, kes on pöördunud Osaleja poole tarbijakrediidilepingu sõlmimise sooviga.
* '''Krediidisaaja''' (''consumer'') – eraisik, kellele Osaleja on väljastanud tarbijakrediidilepingu alusel krediidi.
* '''Tarbijakrediit''' (''consumer credit'') – Osaleja poolt Krediidisaajale väljastatud krediit;
* '''Krediidiotsus''' (''credit decision'') – Osaleja poolt langetatav otsus tarbijakrediidilepingu sõlmimiseks Kreediiditaotlejaga;
* '''Tarbijakrediidileping''' (''consumer credit contract'') – leping, mille alusel on Osaleja väljastanud Krediidisaajale krediidi;
* '''Kaastaotleja''' (''codebtor'') - isik, kellega Krediiditaotleja koos krediiti taotleb ja kelle sissetulekud ning varad võetakse Krediidiotsuse tegemisel arvesse;
* '''Käendaja''' (''guarantor'') - isik, kes võtab Osaleja ees kohustuse vastutada Krediidisaaja Tarbijakrediidi kohustuse täitmise eest;
* '''Tarbijakrediidilepingu subjekt''' (''subject'')- lepingu osapool;
* '''Osaleja''' (''member'') – Andmevahetussüsteemiga liitunud Eesti või välismaa ettevõte, kes jagab temale teadaolevaid Andmeid Krediiditaotleja kohta samaväärses koosseisus teiste Osalejatega;
* '''Krediiditaotleja nõusolek''' (''consent'') - Krediiditaotleja nõusolek päringu adressaatideks olevatele Osalejatele Krediiditaotleja Andmete edastamiseks päringu teinud Osalejale.


= Teenuste kasutamine testkeskkonnas =
Andmevahetussüsteemi testimine toimub x-tee testkeskonna vahendusel. Eelnevalt tuleb test-x-tee testkeskkonnaga liituda, paigaldada ja seadistada test-x-tee turvaserverit ning küsida ligipääsuõigused teenustele Creditinfolt.


= Ärireeglid =
Päringu edastamiseks testkeskkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "ee-test" ning saata päringu test-x-tee turvaserverisse.
* ''Andmevahetussüsteemi'' kasutajad on ''Osalejad''.
* ''Osaleja'' peab olema liitunud X-teega.
* ''Osaleja'' sisestab ''Andmed'' ''Andmevahetussüsteemi haldaja ''andmebaasi või tekitab ''Andmevahetussüsteemi haldajale ''tehnoloogiline võimalus ''Andmeid'' pärida oma ''Andmekogust.''
* ''Osaleja'' uuendab ''Andmed'' edastades ''Andmevahetussüsteemi haldajale ''kas kõik kehtivad ''Andmed'' või ''Tarbijakrediidilepingu'' kaupa.
* ''Osaleja'' uuendab ''Andmed'' iga 24 tunni järel. Äärmisel juhul kuni 7 päeva järel.
* ''Osaleja'' pärib ''Krediiditaotleja'' kohta ''Andmeid'' tema ''Nõusoleku'' olemaolul. ''Nõusolek'' peab olema digitaalselt allkirjastatud.
* ''Nõusolek'' säilib ''Andmevahetussüsteemis'' 3 aastat.
* ''Admete'' päringu vastus ei kajasta andmeid ''Osaleja'' kohta.
* ''Andmete'' päringu vastus ei sisalda päringut teinud ''Osaleja Andmekogust'' ''Andmeid''.
* ''Andmete'' päringu vastuse koosseis kirjeldatud peatükis "Andmete koosseis".
* ''Osalejad'' jagavad ''Andmeid'' samaväärses koosseisus teiste ''Osalejatega.''


== Andmete kooseis ==
Testida võimalik wsdl-s kirjeldatud teenused milledele ligipääs antud ning [http://x-road.eu/docs/x-road_service_metadata_protocol.pdf x-tee metateenused] nagu "listMethods" ja "allowedMethods". Metateenustele ligipääsuõigusi ei anta.
#Uuendamise kuupäev ''(update date and time)''
#Isikukood ''(identity code)''
#Isiku roll ''(role)'' antud lepingu raames
#Lepingu number (''contract number'') - Osaleja ja Krediidisaaja vahel sõlmitud Tarbijakrediidilepingu number;
#Krediidi liik (''type of credit'')
#Krediidi algus (''effective date of credit agreement'') – Tarbijakrediidilepingu kehtivuse alguskuupäev
#Krediidi lõpp (end date of credit) – Kuupäev, millal Tarbijakrediit tuleb tagastada
#Krediidi summa (''credit sum'') - Krediidisaajale väljamakstud või väljamaksmisele kuuluv maksimaalne Tarbijakrediidi summa;
#Krediidi valuuta (''credit currency'') - Tarbijakrediidi valuuta;
#Maksegraafik (''schedule payments'') – Järgmise või lähima kolme väljamakse summa ja tähtaeg;
#Hetkesaldo (''balance'') - Tarbija kohustuse suurus Osaleja ees;
#Üle tähtaja saldo (''days over net balance'') – 7 päeva üle maksetähtaja hilinenud maksete summa.  
#Päringud ''(inquiries)'' – Krediidisaaja kohta Andmete saamiseks viimase kolme aasta jooksul tehtud päringute kuupäevad.


'''Isiku rollid'''
= WSDL =


# Krediidisaaja (''borrower'')
POSR süsteemi WSDL asub aadressil http://services.krediidiinfo.ee/posr.wsdl.
# Kaastaotleja (''codebtor'')
# Käendaja (''guarantor'')


'''Krediidi liigid'''
= 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.


# Tagatisega laen (''secured loan'')
SOAP ümbrik koosneb päisest ja kehast.
# Järelmaks (''hire-purchase'')
# Tagatiseta laen (''unsecured loan)''
# Liising (''lease'')
# Krediitkaart (''credit card'')
# Muu (''other'')


== SOAP ümbriku päis ==
SOAP ümbriku päises oleva info koosseis on määratud [http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf X-tee spetsifikatsiooni] poolt.


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


== Päringu soap ümbriku näide ==
<pre>
<?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>
</pre>


[[File:Krediidikohustuste register.jpg]]
== Vastuse soap ümbriku näide ==


<pre>
<?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>
</pre>


== Consent document creation / Nõusoleku dokumendi koostamine ==
= Teenused =
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.


Osaleja pärib Andmevahetussüsteemis koostatud Krediiditaotleja Nõusoleku dokumendi tema Andmete pärimiseks Osalejate andmekogudest.
Teenuste kasutamiseks peavad Osalejal olema õigused antud Creditinfo Eesti AS poolt.


== '''generateConsent.v1''' ==
Teenuse abil koostatakse dokument pdf formaadis, mille digiallkirjastades annab krediiditaotleja nõusoleku tema krediidikohustuste kohta andmete pärimiseks.


== Credit report request / Andmete pärimine ==
=== Päringu soap ümbriku keha parameetrid ===
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.


'''Eeldus''': Päringu sisendiks olev nõusoleku dokument on Andmevahetussüsteemis koostatud.
[[File:GenerateConsentReq.png]]
# Osaleja edastab päringu Andmevahetussüsteemi Krediiditaotleja krediidikohustuste pärimiseks. Päring sisaldab Krediiditaotleja digiallkirjastatud nõusoleku dokumenti;
# Andmevahetussüsteem kogub Andmeid andmebaasist;
# Andmevahetussüsteem edastab kogutud Andmed päringut teinud Osalejale.
Laiendused:
* Andmevahetussüsteemiga liitunud Osaleja Andmed säilivad tema peetavas andmekogus.
::2a. Andmevahetussüsteem kogub Andmeid Osalejate peetavatest andmekogudest.
* Andmete pärimine Osaleja peetavast andmekogust ebaõnnestub
::3a. Andmevahetussüsteem edastab päringu teinud Osalejale kogutud Andmeid ning ebaõnnestunud päringute arvu sisaldavat veateadet.


== Credit data management / Andmete haldus ==
=== Vastuse soap ümbriku keha parameetrid ===


<b>Eeldus:</b> <u>Osaleja</u> on sõlminud käsunduslepingu Andmevahetussüsteemi haldajaga, millega ta on andnud tema peetava andmekogu volitatud töötleja õigused Andmevahetussüsteemi haldajale.
[[File:GenerateConsentResp.png]]


'''Eeldus''': <u>Osalejal</u> on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.
=== Teenuse testimine ===
Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.


<u>Osaleja</u> edastab tema peetava andmekogu andmed Andmevahetussüsteemi haldajale.
== '''getCreditReport.v1''' ==


Krediiditaotleja krediidikohustuste kohta andmete pärimine Osalejate andmekogudest.


[[File:Andmete haldus.jpg]]
=== Päringu soap ümbriku keha parameetrid ===


<b>Stsenaariumid</b>
[[File:GetSubjectPositiveData.png]]


<b>A)</b> <u>Osaleja</u> edastab kõik kehtivad tarbijakrediitide andmed <u>Andmevahetussüsteemi haldajale</u>.
=== Vastuse soap ümbriku keha parameetrid ===


<b>B)</b> <u>Osaleja</u> uuendab tarbijakrediidiandmed Andmevahetussüteemis.
[[File:GetSubjectPositiveDataResponse.png]]


=== Teenuse testimine ===
Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.


== Manager data management / Osaleja andmete haldus ==
Sisendparameetri signed_consent väärtus saab olla suvaline string kodeeritud base64-ga.
<u>Andmevahetussüsteemi haldaja</u> registreerib/kustutab <u>Osaleja</u> kohta andmeid Andmevahetussüteemis.


== '''insertCredit.v1''' ==


= Tegevusdiagrammid =
Ühe tarbijakrediidi andmete registreerimine andmevahetussüsteemi andmebaasis.


Allolev tegevusdiagramm ilustreerib krediiditaotleja krediidivõimelisuse hindamise protsessi.
=== Päringu soap ümbriku keha parameetrid ===


[[File:Krediidiotsuse tegemine.jpg]]
[[File:AddSubjectPositiveData.png | AddSubjectPositiveData]]




= Lingid =
=== Vastuse soap ümbriku keha parameetrid ===
* [[X-tee liides: alamsüsteem POSR|Andmevahetussüsteemi X-tee liides]]
 
[[File:AddSubjectPositiveDataResponse.png | AddSubjectPositiveDataResponse]]
 
=== Teenuse testimine ===
Sisendandmed peavad vastama nõuetele.
 
Teenuse tulemuseks ei uuendata andmeid andmebaasis.
 
== '''updateCredit.v1''' ==
 
Ühe tarbijakrediidi andmete uuendamine andmevahetussüsteemi andmebaasis.
 
=== Päringu soap ümbriku keha parameetrid ===
 
[[File:UpdateSubjectPositiveData.png | UpdateSubjectPositiveData]]
 
 
=== Vastuse soap ümbriku keha parameetrid ===
 
[[File:UpdateSubjectPositiveDataResponse.png | UpdateSubjectPositiveDataResponse]]
 
 
 
=== Teenuse testimine ===
Sisendandmed peavad vastama nõuetele.
 
Teenuse tulemuseks ei salvestata andmeid andmebaasi.
 
== '''deleteCredit.v1''' ==
 
Ühe tarbijakrediidi andmete kustutamine andmevahetussüsteemi andmebaasist.
 
=== Päringu soap ümbriku keha parameetrid ===
 
[[File:DeleteSubjectPositiveData.png | DeleteSubjectPositiveData]]
 
 
=== Vastuse soap ümbriku keha parameetrid ===
 
[[File:DeleteSubjectPositiveDataResponse.png | DeleteSubjectPositiveDataResponse]]
 
 
===Teenuse testimine===
Sisendandmed peavad vastama nõuetele.
 
Teenuse tulemuseks ei kustutata andmeid andmebaasist.
== '''uploadCreditsMtom.v1''' ==
 
Kõigi kehtivate tarbijakrediitide andmete sisse importimine andmevahetussüsteemi andmebaasi.
 
=== Päring ===
 
Päringu sõnum on <b>MTOM/XOP</b> formaadis, mis vastab SOAP <b>multipart/related</b> 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:
 
[[File:UploadPositiveDataMtom.png | UploadPositiveDataMtom]]
 
 
[[File:Loaninfo debtors.png]]
 
 
Näitepäring:
 
<pre>
...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--
</pre>
 
=== Vastuse soap ümbriku keha parameetrid ===
 
[[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]]
 
=== Teenuse testimine ===
Sõnumi teises osas oleva attachment saab olla suvaline string kodeeritud base64-ga. Andmete importimist ei toimu.
 
== '''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 ===
 
[[File:UploadPositiveDataStatus.png | UploadPositiveDataStatus]]
 
 
=== Vastuse soap ümbriku keha parameetrid ===
 
[[File:UploadPositiveDataStatusResponse.png | UploadPositiveDataStatusResponse]]
 
=== Teenuse testimine ===
Sisendparameeter doc_id võib suvaline number olla.
 
Teenuse tulemuseks on suvaline staatus.
 
= Tehniline viga =
 
<pre>
<?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>
</pre>
 
= Veakoodid =
<table>
  <tr>
    <td>'''-50200'''</td>
    <td>'''Internal service error'''</td>
  </tr>
  <tr>
    <td></td>
    <td>Sisemine viga</td>
  </tr>
  <tr>
    <td>'''-50201'''
'''-50301'''
</td>
    <td>'''Invalid request'''</td>
  </tr>
  <tr>
    <td></td>
    <td>Vigane päringu formaat või sisu</td>
  </tr>
  <tr>
    <td>'''-50202'''</td>
    <td>'''Access denied'''</td>
  </tr>
  <tr>
    <td></td>
    <td>Kasutajal puudub liigipääs süsteemile</td>
  </tr>
  <tr>
    <td>'''-50203'''</td>
    <td>'''Partial data'''</td>
  </tr>
  <tr>
    <td></td>
    <td>Päringu vastus sisaldab osalisi andmeid.</td>
  </tr>
  <tr>
    <td>'''-50250'''</td>
    <td>'''Credit data sync failed'''</td>
  </tr>
  <tr>
    <td></td>
    <td>Tarbijakrediidi andmete sünkroniseerimine (sisestamine, uuendamine, kustutamine) ebaõnnestus</td>
  </tr><tr><td>'''-50252'''</td><td>'''Invalid consent document'''</td></tr><tr><td></td><td>Nõusoleku dokument ei ole pre-genereeritud või on vigane digidoc konteiner.</td></tr><tr><td>'''-50300'''</td><td>'''Invalid xml'''</td></tr><tr><td></td><td>Viga xml-s</td></tr></table>
 
= Lingid =
[[Positiivne_register: funktsionaalne_spetsifikatsioon | Funktsionaalne spetsifikatsioon]]

Revision as of 16:11, 21 March 2017

File:Flag of the United Kingdom.png 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.

Teenuste kasutamine toodangukeskkonnas

POSR süsteemi teenuste kasutamine eeldab, et osaleja on liitunud X-teega, paigaldanud ja seadistanud x-tee tervaserverit ning saanud liigipääsuõigused teenustele Creditinfolt.

Päringu edastamiseks toodangukkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "EE" ning saata päringu toodang x-tee turvaserverisse.

Teenuste kasutamine testkeskkonnas

Andmevahetussüsteemi testimine toimub x-tee testkeskonna vahendusel. Eelnevalt tuleb test-x-tee testkeskkonnaga liituda, paigaldada ja seadistada test-x-tee turvaserverit ning küsida ligipääsuõigused teenustele Creditinfolt.

Päringu edastamiseks testkeskkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "ee-test" ning saata päringu test-x-tee turvaserverisse.

Testida võimalik wsdl-s kirjeldatud teenused milledele ligipääs antud ning x-tee metateenused nagu "listMethods" ja "allowedMethods". Metateenustele ligipääsuõigusi ei anta.

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

Teenuse abil koostatakse dokument pdf formaadis, mille digiallkirjastades annab krediiditaotleja nõusoleku tema krediidikohustuste kohta andmete pärimiseks.

Päringu soap ümbriku keha parameetrid

GenerateConsentReq.png

Vastuse soap ümbriku keha parameetrid

GenerateConsentResp.png

Teenuse testimine

Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.

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

Teenuse testimine

Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.

Sisendparameetri signed_consent väärtus saab olla suvaline string kodeeritud base64-ga.

insertCredit.v1

Ühe tarbijakrediidi andmete registreerimine andmevahetussüsteemi andmebaasis.

Päringu soap ümbriku keha parameetrid

AddSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

AddSubjectPositiveDataResponse

Teenuse testimine

Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei uuendata andmeid andmebaasis.

updateCredit.v1

Ühe tarbijakrediidi andmete uuendamine andmevahetussüsteemi andmebaasis.

Päringu soap ümbriku keha parameetrid

UpdateSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

UpdateSubjectPositiveDataResponse


Teenuse testimine

Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei salvestata andmeid andmebaasi.

deleteCredit.v1

Ühe tarbijakrediidi andmete kustutamine andmevahetussüsteemi andmebaasist.

Päringu soap ümbriku keha parameetrid

DeleteSubjectPositiveData


Vastuse soap ümbriku keha parameetrid

DeleteSubjectPositiveDataResponse


Teenuse testimine

Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei kustutata andmeid andmebaasist.

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

Teenuse testimine

Sõnumi teises osas oleva attachment saab olla suvaline string kodeeritud base64-ga. Andmete importimist ei toimu.

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

Teenuse testimine

Sisendparameeter doc_id võib suvaline number olla.

Teenuse tulemuseks on suvaline staatus.

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 Internal service error
Sisemine viga
-50201

-50301

Invalid request
Vigane päringu formaat või sisu
-50202 Access denied
Kasutajal puudub liigipääs süsteemile
-50203 Partial data
Päringu vastus sisaldab osalisi andmeid.
-50250 Credit data sync failed
Tarbijakrediidi andmete sünkroniseerimine (sisestamine, uuendamine, kustutamine) ebaõnnestus
-50252Invalid consent document
Nõusoleku dokument ei ole pre-genereeritud või on vigane digidoc konteiner.
-50300Invalid xml
Viga xml-s

Lingid

Funktsionaalne spetsifikatsioon

Retrieved from "https://services.krediidiinfo.ee/wiki/index.php?title=Positiivne_register:_funktsionaalne_spetsifikatsioon&oldid=882"