KiCreditManagement: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{| align="right" | |||
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCreditManagement__en|In English]] | |||
|} | |||
= Tutvustus = | = Tutvustus = | ||
KiCreditManagement on | KiCreditManagement on Creditinfo SOAP protokollil põhinev krediidihalduse veebiteenus. | ||
= WSDL = | = WSDL = | ||
Line 9: | Line 14: | ||
= Meetodid = | = Meetodid = | ||
== ''getOverview'' == | == ''getOverview'' == | ||
Line 24: | Line 31: | ||
| Kliendi kood kreeditori infosüsteemis. | | Kliendi kood kreeditori infosüsteemis. | ||
|- | |- | ||
| <b>Väljundparameeter | | <b>Väljundparameeter:</b> | ||
| xml | | xml | ||
| xs:string | | xs:string | ||
| vastus XML formaadis. XML skeem asub aadressil [http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd]. Vaata näidisfaili: [[debtor_cmdata_example.xml]]. Kui päritavat klienti ei ole krediidihalduse andmebaasis, siis on päringu tulemuseks saadav XML-is märgendi ''debtor'' sisu tühi (vt [[debtor_cmdata__example1.xml|näidist]])! | | vastus XML formaadis. XML skeem asub aadressil [http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd]. Vaata näidisfaili: [[debtor_cmdata_example.xml]]. Kui päritavat klienti ei ole krediidihalduse andmebaasis, siis on päringu tulemuseks saadav XML-is märgendi ''debtor'' sisu tühi (vt [[debtor_cmdata__example1.xml|näidist]])! | ||
|} | |} | ||
== ''sendProceedingInfo'' == | |||
Kliendi kohta info edastamine krediidihaldusesse. | |||
{| style="border-style: solid; border-width: 1px;" | |||
! | |||
! Nimi | |||
! Tüüp | |||
! Kirjeldus | |||
|- | |||
| <b>Sisendparameetrid:</b> | |||
| clientCode | |||
| xs:string | |||
| Kliendi kood kreeditori infosüsteemis. | |||
|- | |||
| | |||
| text | |||
| xs:string | |||
| teate sisu vaba tekstina. | |||
|- | |||
| | |||
| type | |||
| xs:int | |||
| teate tüübi kood. Võimalikud väärtused: | |||
* 13 - kreeditori info, | |||
* 20 - inkasso info (mõeldud kreeditori inkasso partneritele). | |||
Kui Creditinfoga pole teisiti kokku lepitud, siis kasutada väärtuseks 13. | |||
|- | |||
| <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 (võib tulevikus juurde tulla): | |||
* -20201 - parameetrile ''clientCode'' vastavat klienti krediidihaldusest ei leitud. Kas kliendikood on vigane või siis ei ole kreeditor antud kliendi infot krediidihaldusesse saatnud. | |||
* -20202 - kasutatud parameetri ''type'' väärtust ei ole lubatud kasutada. | |||
|} | |||
= Arendamine = | |||
Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja: | |||
* Autentimise meetod: ''Basic Authentication'' | |||
* Kasutajanimi: ''30546'' | |||
* Parool: ''soapdemo'' | |||
Näidiskasutaja korral saab meetodi ''getOverview'' parameetril ''clientCode'' olla vaid kolm järgmist väärtust: | |||
* ''full'' - tagastatakse [[debtor_cmdata_example_full.xml|näidis-XML]], kus on täidetud kõik märgendid | |||
* ''minimal'' - tagastatakse [[debtor_cmdata_example_minimal.xml|näidis-XML]], kus on täidetud minimaalsed väljad. | |||
* ''none'' - tagastatakse [[debtor_cmdata_example_none.xml|tühi XML]], mis tagastatakse juhul, kui päritav klient ei ole Creditinfo krediidihalduse andmebaasis. | |||
= Näide PHP-s = | |||
<pre> | |||
<?php | |||
/** | |||
* Example of using Creditinfo AS SOAP interface KiCreditManagement. | |||
* | |||
* In this example the demo username and password is used so there is no need | |||
* to contact with Creditinfo AS in order to run this program. | |||
* | |||
* @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditManagement | |||
* @author Rait Kapp <rait.kapp@experian.com> | |||
* @created 16.09.2010 | |||
*/ | |||
$wsdl_url = 'http://services.krediidiinfo.ee/KiCreditManagement.wsdl'; | |||
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditManagement' | |||
, 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?). | |||
, 'password' => 'soapdemo' // <-- password | |||
); | |||
$client = new SoapClient($wsdl_url, $params); | |||
$clientCode = 'full'; // 'full' is demo client code | |||
$xml = $client->getOverview($clientCode); | |||
print_r($xml); | |||
?> | |||
</pre> |
Latest revision as of 13:50, 2 December 2016
In English |
Tutvustus
KiCreditManagement on Creditinfo SOAP protokollil põhinev krediidihalduse veebiteenus.
WSDL
KiCreditManagement WSDL asub aadresslil http://services.krediidiinfo.ee/KiCreditManagement.wsdl.
Meetodid
getOverview
Kliendi kohta krediidihalduri krediidihinnangu ja krediidijärelvalve ajaloo pärimine.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | clientCode | xs:string | Kliendi kood kreeditori infosüsteemis. |
Väljundparameeter: | xml | xs:string | vastus XML formaadis. XML skeem asub aadressil http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd. Vaata näidisfaili: debtor_cmdata_example.xml. Kui päritavat klienti ei ole krediidihalduse andmebaasis, siis on päringu tulemuseks saadav XML-is märgendi debtor sisu tühi (vt näidist)! |
sendProceedingInfo
Kliendi kohta info edastamine krediidihaldusesse.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | clientCode | xs:string | Kliendi kood kreeditori infosüsteemis. |
text | xs:string | teate sisu vaba tekstina. | |
type | xs:int | teate tüübi kood. Võimalikud väärtused:
Kui Creditinfoga pole teisiti kokku lepitud, siis kasutada väärtuseks 13. | |
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 (võib tulevikus juurde tulla):
|
Arendamine
Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:
- Autentimise meetod: Basic Authentication
- Kasutajanimi: 30546
- Parool: soapdemo
Näidiskasutaja korral saab meetodi getOverview parameetril clientCode olla vaid kolm järgmist väärtust:
- full - tagastatakse näidis-XML, kus on täidetud kõik märgendid
- minimal - tagastatakse näidis-XML, kus on täidetud minimaalsed väljad.
- none - tagastatakse tühi XML, mis tagastatakse juhul, kui päritav klient ei ole Creditinfo krediidihalduse andmebaasis.
Näide PHP-s
<?php /** * Example of using Creditinfo AS SOAP interface KiCreditManagement. * * In this example the demo username and password is used so there is no need * to contact with Creditinfo AS in order to run this program. * * @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditManagement * @author Rait Kapp <rait.kapp@experian.com> * @created 16.09.2010 */ $wsdl_url = 'http://services.krediidiinfo.ee/KiCreditManagement.wsdl'; $params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditManagement' , 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?). , 'password' => 'soapdemo' // <-- password ); $client = new SoapClient($wsdl_url, $params); $clientCode = 'full'; // 'full' is demo client code $xml = $client->getOverview($clientCode); print_r($xml); ?>