KiReport

From services.krediidiinfo.ee
Revision as of 18:29, 5 December 2007 by Rait (talk | contribs) (Silumine)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Tutvustus

KiReport on Krediidiinfo poolt loodud SOAP protokollil põhinev veebiteenus Krediidiinfo raportite pärimiseks. Päringu tulemuseks saadavad raportid on XML formaadis.

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.


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'; 

$params = array('location' => $server_url
              , '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
               );

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

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

$xml = $client->getReport($productCode, $subjectCode);

print_r($xml);

?>

Silumine

Silumise jaoks võib alati pärida raportid koodiga RAXXXE. 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.