KiReport: Difference between revisions
No edit summary |
|||
(17 intermediate revisions by 7 users not shown) | |||
Line 5: | Line 5: | ||
= Tutvustus = | = Tutvustus = | ||
KiReport on | 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 | KiReport WSDL asub aadressil [https://services.krediidiinfo.ee/KiReport.wsdl https://services.krediidiinfo.ee/KiReport.wsdl]. | ||
KiReport UTF-8 WSDL asub aadressil [https://services.krediidiinfo.ee/KiReportUTF8.wsdl https://services.krediidiinfo.ee/KiReportUTF8.wsdl] | |||
= Meetodid = | = Meetodid = | ||
Line 32: | 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>Väljundparameeter:</b> | ||
| xml | | xml | ||
| xs:string | | xs:string | ||
Line 39: | 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 [https://services.krediidiinfo.ee/schemas/services/KiReport__getAvailableReports.xsd https://services.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 47: | Line 84: | ||
<?php | <?php | ||
/** | /** | ||
* Example of using KiReport web service of | * Example of using KiReport web service of Creditinfo AS | ||
* Certificate issued by | * Certificate issued by Creditinfo is needed to use KiReport interface. | ||
* | * | ||
* @author Rait Kapp <rait@ | * @author Rait Kapp <rait@creditinfo.ee> | ||
* @created 18.09.2007 | * @created 18.09.2007 | ||
*/ | */ | ||
$wsdl_url = ' | $wsdl_url = 'https://services.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 | ||
, 'login' => 'online_code' // Online Code issued by | , 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?). | ||
, 'password' => 'passwd' | , '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 | ||
Line 82: | Line 115: | ||
if (isset($e->detail)) { | if (isset($e->detail)) { | ||
// $e->details->errorcode tähendusi vaata Veakoodide alt. | // $e->details->errorcode tähendusi vaata Veakoodide alt. | ||
echo " | echo "Creditinfo SOAP serveri poolt tagastatud vea kood: " . $e->detail->errorcode . "\n"; | ||
} | } | ||
} | } | ||
$xml = $client->getAvailableReports(); | |||
echo $xml; | |||
?> | ?> | ||
Line 93: | Line 129: | ||
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]. | 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 | Raportis on loodud märgendid kõigis skalaarsetes tüüpides, mida Creditinfo XML-ides kasutatakse. | ||
Raporti ''RAXXXE'' näidis: | Raporti ''RAXXXE'' näidis: | ||
<pre> | <pre> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<report xmlns=" | <report xmlns="https://services.krediidiinfo.ee/schemas/report//RAXXXE.xsd"> | ||
<date_tag>2007-10-23</date_tag> | <date_tag>2007-10-23</date_tag> | ||
<date_time>2007-10-23T10:10:42</date_time> | <date_time>2007-10-23T10:10:42</date_time> | ||
Line 117: | Line 153: | ||
==-20101 No permission for PRODUCT_CODE! == | ==-20101 No permission for PRODUCT_CODE! == | ||
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]]. | Lisaks teenusespetsiifilistele veakoodidele on veel [[Veakoodid | süsteemsed veakoodid]]. |
Latest revision as of 15:02, 17 April 2024
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
- 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
KiReport WSDL asub aadressil https://services.krediidiinfo.ee/KiReport.wsdl.
KiReport UTF-8 WSDL asub aadressil https://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 https://services.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 = 'https://services.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="https://services.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>& ' " < ></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.