Difference between revisions of "KiReport"

From services.krediidiinfo.ee
Jump to: navigation, search
(lisatud link inglise keelsele tõlkele)
 
(25 intermediate revisions by 6 users not shown)
Line 5: Line 5:
 
= Tutvustus =  
 
= Tutvustus =  
  
KiReport on Krediidiinfo poolt loodud SOAP protokollil põhinev veebiteenus Krediidiinfo raportite pärimiseks. Päringu tulemuseks saadavad raportid on XML formaadis.
+
KiReport ehk XML raportite pärimine on Creditinfo 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
 +
# Leppige kliendihalduriga kokku raporti täpne struktuur ja hind
 +
# Kliendihaldur laseb IT osakonnal koostada Teie jaoks raporti
 +
# Kliendihaldur saadab Teile raporti testimiseks:
 +
## Testkasutaja kasutajatunnuse, parooli
 +
## Raportite pärimise liidese kirjelduse
 +
## Raporti skeemi (XSD schema) ja kirjelduse
 +
## Kõikide võimalike eranditega „Test“ raportite isiku-/registrikoodid
 +
# Kui olete raporti testimise lõpetanud, saadab kliendihaldur Teile liidese- ja konkreetse raporti õigustega kasutajakonto.
  
 
= WSDL =
 
= WSDL =
  
KiReport WSDL asub aadresslil [http://services.krediidiinfo.ee/KiDocExchange.wsdl http://services.krediidiinfo.ee/KiReport.wsdl].
+
KiReport WSDL asub aadressil [http://services.krediidiinfo.ee/KiReport.wsdl http://services.krediidiinfo.ee/KiReport.wsdl].
  
 +
KiReport UTF-8 WSDL asub aadressil [http://services.krediidiinfo.ee/KiReportUTF8.wsdl http://services.krediidiinfo.ee/KiReportUTF8.wsdl]
  
 
= Meetodid =
 
= Meetodid =
Line 33: Line 44:
 
| Subjekti kood (sõltuvalt raportist võib subjekti koodiks olla kas ettevõtte äriregistrikood, eraisiku isikukood vms)
 
| Subjekti kood (sõltuvalt raportist võib subjekti koodiks olla kas ettevõtte äriregistrikood, eraisiku isikukood vms)
 
|-
 
|-
| <b>Väljundparameeter::</b>
+
| <b>Väljundparameeter:</b>
 
| xml
 
| xml
 
| xs:string
 
| xs:string
Line 40: Line 51:
  
  
 +
== ''getAvailableReports'' ==
 +
 +
Isikul saadaval olevate raportite loendi pärimine.
 +
 +
{| style="border-style: solid; border-width: 1px;"
 +
!
 +
! Nimi
 +
! Tüüp
 +
! Kirjeldus
 +
|-
 +
| <b>Sisendparameetrid:</b>
 +
|
 +
|
 +
|
 +
|-
 +
|
 +
|
 +
|
 +
|
 +
|-
 +
| <b>Väljundparameeter:</b>
 +
| xml
 +
| xs:string
 +
| raportite loend XML formaadis. XML skeem XSD formaadis asub aadressil [http://www.krediidiinfo.ee/schemas/services/KiReport__getAvailableReports.xsd http://www.krediidiinfo.ee/schemas/services/KiReport__getAvailableReports.xsd]. Skeem pildina: [http://www.krediidiinfo.ee/schemas/services/KiReport__getAvailableReports.png 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 =
 
=Näide PHP-s =
Line 48: Line 84:
 
<?php
 
<?php
 
/**
 
/**
  * Example of using KiReport web service of Krediidiinfo AS
+
  * Example of using KiReport web service of Creditinfo AS
  * Certificate issued by Krediidiinfo is needed to use KiReport interface.
+
  * Certificate issued by Creditinfo is needed to use KiReport interface.
 
  *  
 
  *  
  * @author Rait Kapp <rait@krediidiinfo.ee>
+
  * @author Rait Kapp <rait@creditinfo.ee>
 
  * @created 18.09.2007
 
  * @created 18.09.2007
 
  */
 
  */
  
 
$wsdl_url = 'http://www.krediidiinfo.ee/services/KiReport.wsdl';
 
$wsdl_url = 'http://www.krediidiinfo.ee/services/KiReport.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiReport';  
+
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiReport&enc=UTF-8';  
  
 
$params = array('location' => $server_url
 
$params = array('location' => $server_url
               , 'local_cert'   => 'path/certificate.pem' // Here goes path to certificate file.
+
               , 'login'         => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
               , 'passphrase'   => 'passwd' // Here goes password of certificate.
+
               , 'password'     => 'passwd'
 +
 
 
//            , 'proxy_host'    => 'cache.neti.ee'  // If necessary use proxy and proxy port.
 
//            , 'proxy_host'    => 'cache.neti.ee'  // If necessary use proxy and proxy port.
 
//            , 'proxy_port'    => 8080
 
//            , 'proxy_port'    => 8080
 +
              , 'encoding' => 'UTF-8'
 
               );
 
               );
  
Line 70: Line 108:
 
$subjectCode = '00000000';
 
$subjectCode = '00000000';
  
$xml = $client->getReport($productCode, $subjectCode);
+
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 "Creditinfo SOAP serveri poolt tagastatud vea kood: " . $e->detail->errorcode . "\n";
 +
    }
 +
}
  
print_r($xml);
+
$xml = $client->getAvailableReports();
 +
echo $xml;
  
 
?>
 
?>
Line 79: Line 127:
 
= Silumine =
 
= 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 http://www.krediidiinfo.ee/schemas/report/RAXXXE.xsd].  
+
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 http://www.krediidiinfo.ee/schemas/report/RAXXXE.xsd].  
  
Raportis on loodud märgendid kõigis skalaarsetes tüüpides, mida Krediidiinfo XML-ides kasutatakse.  
+
Raportis on loodud märgendid kõigis skalaarsetes tüüpides, mida Creditinfo XML-ides kasutatakse.  
 
Raporti ''RAXXXE'' näidis:
 
Raporti ''RAXXXE'' näidis:
  
Line 105: Line 153:
 
==-20101 No permission for PRODUCT_CODE! ==
 
==-20101 No permission for PRODUCT_CODE! ==
  
Krediidiinfo AS ei ole andnud kliendile õiguseid pärida vastavat raportit. Õiguste saamiseks võtta ühendust [[Klienditugi| klienditoega]].
+
Creditinfo Eesti AS ei ole andnud kliendile õiguseid pärida vastavat raportit. Õiguste saamiseks võtta ühendust [[Klienditugi| klienditoega]].
 +
 
 +
==-20102 Subject code value is missing!==
 +
 
 +
Meetodi "getReport" sisendparameetril "subjectCode" 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 [[Klienditugi| 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 Creditinfos.
 +
 
 +
== -10183 INVALID_SUBJECT_CODE==
 +
 
 +
Ei saa koostada raportit sest subjekt puudub Creditinfos.
 +
 
 +
 
 +
 
 +
Lisaks teenusespetsiifilistele veakoodidele on veel [[Veakoodid | süsteemsed veakoodid]].

Latest revision as of 13:29, 6 February 2020

Flag of the United Kingdom.svg In English

Tutvustus

KiReport ehk XML raportite pärimine on Creditinfo 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 aadressil http://services.krediidiinfo.ee/KiReport.wsdl.

KiReport UTF-8 WSDL asub aadressil http://services.krediidiinfo.ee/KiReportUTF8.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 Creditinfo AS
 * Certificate issued by Creditinfo is needed to use KiReport interface.
 * 
 * @author Rait Kapp <rait@creditinfo.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 Creditinfo client management. Make sure that login value is string type (PHP bug?).
              , 'password'      => 'passwd'

//            , '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 "Creditinfo 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 Creditinfo 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!

Creditinfo Eesti 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.

-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 Creditinfos.

-10183 INVALID_SUBJECT_CODE

Ei saa koostada raportit sest subjekt puudub Creditinfos.


Lisaks teenusespetsiifilistele veakoodidele on veel süsteemsed veakoodid.