KiReportExt

From services.krediidiinfo.ee
Revision as of 15:20, 3 August 2016 by Julia (talk | contribs)
Jump to navigation Jump to search

Tutvustus

KiReportExt ehk XML raportite pärimine on Krediidiinfo poolt loodud SOAP protokollil põhinev veebiteenus. Päringu tulemuseks saadavad raportid on XML formaadis. KiReportExt on liidese KiReport laiendus. Erinevus KiReport liidesest seisneb selles, et kasutaja saab edastada raporti koostamiseks vajalikke lisaandmeid.

XML raporti tellimine

  1. Leppige kliendihalduriga kokku raporti täpne struktuur ja hind
  2. Kliendihaldur laseb IT osakonnal koostada Teie jaoks raporti
  3. Kliendihaldur saadab Teile raporti testimiseks:
    1. Testkasutaja kasutajatunnuse, parooli
    2. Raportite pärimise liidese kirjelduse
    3. Raporti skeemi (XSD schema) ja kirjelduse
    4. Kõikide võimalike eranditega „Test“ raportite isiku-/registrikoodid
  4. Kui olete raporti testimise lõpetanud, saadab kliendihaldur Teile liidese- ja konkreetse raporti õigustega kasutajakonto.

WSDL

KiReportExt WSDL asub aadresslil http://services.krediidiinfo.ee/KiReportExt.wsdl.

Meetodid

getReport

Raporti pärimine.

Nimi Tüüp Kirjeldus
Sisendparameeter: prosuctCode xs:string Raporti tootekood.
Sisendparameeter: subjectCode xs:string Subjekti kood, kelle/mille kohta on raport.
Sisendparameeter: xml xs:any Kokkulepitud struktuuriga xml sisendandmetega.
Väljundparameeter: xml xs:any Päritud raport XML formaadis.

Näide PHP-s

KiReportExt kasutamise näide PHP-s:

<?php
/**
 * Example of using KiReportExt web service of Krediidiinfo AS
 * Certificate issued by Krediidiinfo is needed to use KiReportExt interface.
 * 
 */

$wsdl_url = 'http://www.krediidiinfo.ee/services/KiReportExt.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiReportExt'; 

$params = array('location' => $server_url
              , 'login'    => 'online_code' // Online Code issued by Krediidiinfo client management. Make sure that login value is string type (PHP bug?).
              , 'password'      => 'passwd'

/*            If you want to use certificate, then uncomment this block and comment params login and password!
              , 'local_cert'    => 'path/certificate.pem' // Here goes path to certificate file.
              , 'passphrase'    => 'passwd'  // Here goes password of certificate.
*/
//            , 'proxy_host'    => 'cache.neti.ee'   // If necessary use proxy and proxy port.
//            , 'proxy_port'    => 8080
              , 'encoding' => 'UTF-8'
               );

$client = new SoapClient($wsdl_url, $params);

$inputXml = '<foo><bar></bar></foo>';
$soapParams = new stdClass();
$soapParams->productCode = RAXXXX;
$soapParams->subjectCode = 00000000;
$soapParams->any = new SoapVar($inputXml, XSD_ANYXML);

try {
    $xml = $client->getReport($soapParams);
    echo $xml->any;
} catch (Exception $e) {
    echo "Raporti pärimine ebaõnnestus vea teatega: " . $e->getMessage() . "\n";
    if (isset($e->detail)) {
        // $e->details->errorcode tähendusi vaata Veakoodide alt.
        echo "Krediidiinfo SOAP serveri poolt tagastatud vea kood: " . $e->detail->errorcode . "\n";
    }
}

?>


Veakoodid

-20101 No permission for PRODUCT_CODE!

Krediidiinfo AS ei ole andnud kliendile õiguseid pärida vastavat raportit. Õiguste saamiseks võtta ühendust klienditoega.

-20102 Subject code value is missing!

Meetodi "getReport" sisendparameetril "subjectCode" puudub väärtus.

-20106 Product code value is missing!

Meetodi "getReport" sisendparameetril "productCode" puudub väärtus.

-20103 Invalid subject code value!

Meetodi "getReport" sisendparameeter "subjectCode" väärtus ei ole korrektne.

-10186 No Report

Antud subjekti kohta raportit ei eksisteeri.

-20104 No price registred for product PRODUCT_CODE!

Puudub tootehind. Võtke ühendust klienditoega.

-20105 INVALID_TEST_REPORT

Kasutajale ei ole loodud sisendparameetritele "subjectCode" ja "productCode" vastava testraporti.

-10184 DATA_NOT_AVAILABLE

Ei saa koostada raportit sest puuduvad subjekti kohta andmed Krediidiinfos.

-10183 INVALID_SUBJECT_CODE

Ei saa koostada raportit sest subjekt puudub Krediidiinfos.


Lisaks teenusespetsiifilistele veakoodidele on veel süsteemsed veakoodid.