KiReport

In English

Tutvustus

KiReport ehk XML raportite pärimine on Krediidiinfo poolt loodud SOAP protokollil põhinev veebiteenus. Päringu tulemuseks saadavad raportid on XML formaadis. Raporti pärimiseks muudes formaatides kasutage raportite pärimise otselinki kireport.php.

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

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

Meetodid

getReport

Raporti pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	productCode	xs:string	Toote kood.
	subjectCode	xs:string	Subjekti kood (sõltuvalt raportist võib subjekti koodiks olla kas ettevõtte äriregistrikood, eraisiku isikukood vms)
Väljundparameeter:	xml	xs:string	Päritud raport XML formaadis.

getAvailableReports

Isikul saadaval olevate raportite loendi pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:
Väljundparameeter:	xml	xs:string	raportite loend XML formaadis. XML skeem XSD formaadis asub aadressil http://www.krediidiinfo.ee/schemas/services/KiReport__getAvailableReports.xsd. Skeem pildina: KiReport__getAvailableReports.png. Kui isikul ei ole ühtegi raportit saadaval, siis on päringu tulemuseks saadav XML-is märgendi available_reports sisu tühi!

Näide PHP-s

KiReport kasutamise näide PHP-s:

<?php
/**
 * Example of using KiReport web service of Krediidiinfo AS
 * Certificate issued by Krediidiinfo is needed to use KiReport interface.
 * 
 * @author Rait Kapp <rait@krediidiinfo.ee>
 * @created 18.09.2007
 */

$wsdl_url = 'http://www.krediidiinfo.ee/services/KiReport.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiReport&enc=UTF-8'; 

$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);

$productCode = 'RAXXXE';
$subjectCode = '00000000';

try {
    $xml = $client->getReport($productCode, $subjectCode);
    print_r($xml);
} 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";
    }
}

$xml = $client->getAvailableReports();
echo $xml;

?>

Silumine

Silumise jaoks võib alati pärida raportid koodiga RAXXXE. RAXXXE päringute eest tasu ei võeta! Raporti RAXXXE XML skeem asub aadressil http://www.krediidiinfo.ee/schemas/report/RAXXXE.xsd.

Raportis on loodud märgendid kõigis skalaarsetes tüüpides, mida Krediidiinfo XML-ides kasutatakse. Raporti RAXXXE näidis:

<?xml version="1.0" encoding="UTF-8"?>
<report xmlns="http//www.krediidiinfo.ee/schemas/report/RAXXXE.xsd">
    <date_tag>2007-10-23</date_tag>
    <date_time>2007-10-23T10:10:42</date_time>
    <int_tag>12345</int_tag>
    <decimal_tag>123456.789</decimal_tag>
    <string_tag>I am a string</string_tag>
    <codes_tag>&amp; '  &quot; &lt; &gt;</codes_tag>
    <est_character_tag>õ ä ö ü Õ Ä Ö Ü</est_character_tag>
    <subject_code>00000000</subject_code>
</report>

Märgendi subject_code väärtuseks on alati meetodi sisendparameetri subjectCode väärtus.

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!

KiReport meetodile getReport sisendparameetril subjectCode puudub väärtus.

-20103 Invalid subject code value!

Ette antud subjekti kood ei ole korrektne.

-10186 No Report

Antud subjekti kohta raportit ei eksisteeri. Näiteks kui päritakse ettevõtte aasta aruannet aga ettevõte ei ole seda esitanud.

-20104 No price registred for product PRODUCT_CODE!

Kliendihalduses ei ole registreeritud toote hinda. Võtke ühendust klienditoega.

-20105 INVALID_TEST_REPORT 

Test raportid tehtud konkreetsele subjektile, tootele ja pärijale. Nii et, kui üks nendest vale, siis tuleb veatede.

-10184 DATA_NOT_AVAILABLE 

Raportite ei saa genereerida, kuna subjekti kohta puuduvad Krediidiinfo andmebaasis andmed.

-10183 INVALID_SUBJECT_CODE

Raportite ei saa genereerida, kuna subjekti kohta puuduvad Krediidiinfo andmebaasis andmed.

Lisaks teenusespetsiifilistele veakoodidele on veel süsteemsed veakoodid.