KiCreditRiskManagement: Difference between revisions
(Created page with "{| align="right" | border|30px In English |} = Tutvustus = KiCreditRiskManagement on Krediidiinfo SOAP ...") |
No edit summary |
||
(24 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{| align="right" | {| align="right" | ||
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[ | | [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCreditRiskManagement__en|In English]] | ||
|} | |} | ||
Line 6: | Line 6: | ||
= Tutvustus = | = Tutvustus = | ||
KiCreditRiskManagement on | KiCreditRiskManagement on Creditinfo SOAP protokollil põhinev krediiriskide halduse veebiteenus. | ||
= WSDL = | = WSDL = | ||
KiCreditRiskManagement WSDL asub aadresslil [ | KiCreditRiskManagement WSDL asub aadresslil [https://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl https://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl]. | ||
Line 35: | Line 35: | ||
| resultCode | | resultCode | ||
| xs:int | | xs:int | ||
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused siin. | | kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin]. | ||
|} | |} | ||
== ''end'' == | |||
Ettevõtte krediidiriskide jälgimise lõpetamine. Teenuse lõpukuupäevaks määratakse järgneva kuu viimane päev, kui teenus on alustatud käesoleval kuul ning varem alustatud teenuse puhul käesoleva kuu viimane päev. | |||
{| style="border-style: solid; border-width: 1px;" | |||
! | |||
! Nimi | |||
! Tüüp | |||
! Kirjeldus | |||
|- | |||
| <b>Sisendparameetrid:</b> | |||
| regCode | |||
| xs:string | |||
| Ettevõtte registrikood. | |||
|- | |||
| <b>Väljundparameeter:</b> | |||
| resultCode | |||
| xs:int | |||
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin]. | |||
|} | |||
== ''getCreditRiskData'' == | |||
Ettevõtte krediidiriskide põhiandmete ja sündmuste pärimine. | |||
{| style="border-style: solid; border-width: 1px;" | |||
! | |||
! Nimi | |||
! Tüüp | |||
! Kirjeldus | |||
|- | |||
| <b>Sisendparameetrid:</b> | |||
| regCode | |||
| xs:string | |||
| Ettevõtte registrikood. | |||
|- | |||
| <b>Väljundparameeter:</b> | |||
| xml | |||
| xs:string | |||
| vastus XML formaadis. XML skeem asub aadressil [https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd]. Vaata näidisfaili: [https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xml KiCreditRiskManagement__getCreditRiskData.xml]. Kui päritav ettevõte ei ole krediidiriskide jälgimise all, siis on päringu tulemuseks saadav XML-is märgendi ''company'' sisu tühi! | |||
|} | |||
== ''getEvents'' == | |||
Etteantud ajavahemikus (maksimaalselt 30 päeva) toimunud sündmuste pärimine. | |||
{| style="border-style: solid; border-width: 1px;" | |||
! | |||
! Nimi | |||
! Tüüp | |||
! Kirjeldus | |||
|- | |||
| <b>Sisendparameetrid:</b> | |||
| begin | |||
| xs:date | |||
| Alguskuupäev (ka), millest alates toimunud sündmusi soovitakse pärida. | |||
|- | |||
| | |||
| end | |||
| xs:date | |||
| Lõpukuupäev (ka), milleni toimunud sündmusi soovitakse pärida. | |||
|- | |||
| <b>Väljundparameeter:</b> | |||
| xml | |||
| xs:string | |||
| vastus XML formaadis. XML skeem asub aadressil [https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd]. Vaata näidisfaili: [https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xml KiCreditRiskManagement__getEvents.xml]. | |||
|} | |||
= Veakoodid = | = Veakoodid = | ||
Line 57: | Line 127: | ||
Ettevõte ei ole krediidiriskide jälgimise all. | Ettevõte ei ole krediidiriskide jälgimise all. | ||
== -20404 LONG_PERIOD == | |||
Liiga pikk ajavahemik, milles registreeritud andmeid soovitakse pärida. | |||
Line 67: | Line 141: | ||
* Kasutajanimi: ''30546'' | * Kasutajanimi: ''30546'' | ||
* Parool: ''soapdemo'' | * Parool: ''soapdemo'' | ||
Line 75: | Line 151: | ||
<?php | <?php | ||
/** | /** | ||
* Example of using | * Example of using Creditinfo Eesti AS SOAP interface KiCreditRiskManagement. | ||
* | * | ||
* In this example the demo username and password is used so there is no need | * In this example the demo username and password is used so there is no need | ||
* to contact with | * to contact with Creditinfo Eesti AS in order to run this program. | ||
* | * | ||
* @link | * @link https://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement | ||
* @author Julia Parkkonen <julia.parkkonen@ | * @author Julia Parkkonen <julia.parkkonen@creditinfo.ee> | ||
* @created 04.06.2013 | * @created 04.06.2013 | ||
*/ | */ | ||
$wsdl_url = ' | $wsdl_url = 'https://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl'; | ||
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement' | $params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement' | ||
, 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?). | , 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?). | ||
Line 98: | Line 174: | ||
} | } | ||
$xml = $client->getCreditRiskData($regCode); | |||
echo $xml; | |||
$resultCode = $client->end($regCode); | |||
if ($resultCode == 0) { | |||
echo "Ettevõte krediidiriskide jälgimine on lõpetatud!"; | |||
} | |||
$xml = $client->getEvents('2013-01-01', '2013-01-07'); | |||
echo $xml; | |||
?> | ?> | ||
</pre> | </pre> |
Latest revision as of 15:21, 17 April 2024
In English |
Tutvustus
KiCreditRiskManagement on Creditinfo SOAP protokollil põhinev krediiriskide halduse veebiteenus.
WSDL
KiCreditRiskManagement WSDL asub aadresslil https://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl.
Meetodid
start
Ettevõtte lisamine krediidiriskide jälgimise alla.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | regCode | xs:string | Ettevõtte registrikood. |
Väljundparameeter: | resultCode | xs:int | kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused siin. |
end
Ettevõtte krediidiriskide jälgimise lõpetamine. Teenuse lõpukuupäevaks määratakse järgneva kuu viimane päev, kui teenus on alustatud käesoleval kuul ning varem alustatud teenuse puhul käesoleva kuu viimane päev.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | regCode | xs:string | Ettevõtte registrikood. |
Väljundparameeter: | resultCode | xs:int | kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused siin. |
getCreditRiskData
Ettevõtte krediidiriskide põhiandmete ja sündmuste pärimine.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | regCode | xs:string | Ettevõtte registrikood. |
Väljundparameeter: | xml | xs:string | vastus XML formaadis. XML skeem asub aadressil https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd. Vaata näidisfaili: KiCreditRiskManagement__getCreditRiskData.xml. Kui päritav ettevõte ei ole krediidiriskide jälgimise all, siis on päringu tulemuseks saadav XML-is märgendi company sisu tühi! |
getEvents
Etteantud ajavahemikus (maksimaalselt 30 päeva) toimunud sündmuste pärimine.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | begin | xs:date | Alguskuupäev (ka), millest alates toimunud sündmusi soovitakse pärida. |
end | xs:date | Lõpukuupäev (ka), milleni toimunud sündmusi soovitakse pärida. | |
Väljundparameeter: | xml | xs:string | vastus XML formaadis. XML skeem asub aadressil https://services.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd. Vaata näidisfaili: KiCreditRiskManagement__getEvents.xml. |
Veakoodid
-20400 UNKNOWN
Tundmatu viga
-20401 INVALID_REGCODE
Vigane ettevõtte registrikood
-20402 SERVICE_ALREADY_ACTIVE
Ettevõte on juba krediidiriskide jälgimise all.
-20403 SERVICE_INACTIVE
Ettevõte ei ole krediidiriskide jälgimise all.
-20404 LONG_PERIOD
Liiga pikk ajavahemik, milles registreeritud andmeid soovitakse pärida.
Arendamine
Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:
- Autentimise meetod: Basic Authentication
- Kasutajanimi: 30546
- Parool: soapdemo
Näide PHP-s
<?php /** * Example of using Creditinfo Eesti AS SOAP interface KiCreditRiskManagement. * * In this example the demo username and password is used so there is no need * to contact with Creditinfo Eesti AS in order to run this program. * * @link https://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement * @author Julia Parkkonen <julia.parkkonen@creditinfo.ee> * @created 04.06.2013 */ $wsdl_url = 'https://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl'; $params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement' , 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?). , 'password' => 'soapdemo' // <-- password ); $client = new SoapClient($wsdl_url, $params); $regCode = '10256137'; $resultCode = $client->start($regCode); if ($resultCode == 0) { echo "Ettevõte lisatud krediidiriskide jälgimise alla!"; } $xml = $client->getCreditRiskData($regCode); echo $xml; $resultCode = $client->end($regCode); if ($resultCode == 0) { echo "Ettevõte krediidiriskide jälgimine on lõpetatud!"; } $xml = $client->getEvents('2013-01-01', '2013-01-07'); echo $xml; ?>