KiCreditManagement en: Difference between revisions

From services.krediidiinfo.ee
Jump to navigation Jump to search
(Created page with "= Tutvustus = KiCreditManagement on Krediidiinfo SOAP protokollil põhinev krediidihalduse veebiteenus. = WSDL = KiCreditManagement WSDL asub aadresslil [http://services.k...")
 
No edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Tutvustus =  
{| align="right"
| [[Image:Flag of Estonia.svg|border|30px]] [[KiCreditRiskManagement|eesti keeles]]
|}
 
= Introduction =  


KiCreditManagement on Krediidiinfo SOAP protokollil põhinev krediidihalduse veebiteenus.
KiCreditManagement is the name of a Web Service based on SOAP protocol.


= WSDL =
= WSDL =


KiCreditManagement WSDL asub aadresslil [http://services.krediidiinfo.ee/KiCreditManagement.wsdl http://services.krediidiinfo.ee/KiCreditManagement.wsdl].
KiCreditManagement WDSL is located at  [http://services.krediidiinfo.ee/KiCreditManagement.wsdl http://services.krediidiinfo.ee/KiCreditManagement.wsdl].




= Meetodid =
= Methods =




== ''getOverview'' ==
== ''getOverview'' ==


Kliendi kohta krediidihalduri krediidihinnangu ja krediidijärelvalve ajaloo pärimine.
Requesting events of client's credit risk management and reminder management.


{| style="border-style: solid; border-width: 1px;"
{| style="border-style: solid; border-width: 1px;"
!  
!  
! Nimi
! Name
! Tüüp
! Type
! Kirjeldus
! Description
|-
|-
| <b>Sisendparameetrid:</b>  
| <b>Input parameter:</b>  
| clientCode
| clientCode
| xs:string
| xs:string
| Kliendi kood kreeditori infosüsteemis.
| Client code in creditor's information system.
|-
|-
| <b>Väljundparameeter:</b>
| <b>Output parameter:</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]])!
| Response in XML format. XML layout is located at [http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd]. See an example: [[debtor_cmdata_example.xml]]. An empty tag ''debtor'' will be given in XML, if the requested client does not exist in the credit management database. (see [[debtor_cmdata__example1.xml|example]])!
|}
|}


== ''sendProceedingInfo'' ==
== ''sendProceedingInfo'' ==


Kliendi kohta info edastamine krediidihaldusesse.
Sending information about customers to credit risk management.


{| style="border-style: solid; border-width: 1px;"
{| style="border-style: solid; border-width: 1px;"
!  
!  
! Nimi
! Name
! Tüüp
! Type
! Kirjeldus
! Description
|-
|-
| <b>Sisendparameetrid:</b>  
| <b>Input parameter:</b>  
| clientCode
| clientCode
| xs:string
| xs:string
| Kliendi kood kreeditori infosüsteemis.
| Client code in creditor's information system.
|-
|-
|  
|  
| text
| text
| xs:string
| xs:string
| teate sisu vaba tekstina.
| Content of the message.
|-
|-
|  
|  
| type
| type
| xs:int
| xs:int
| teate tüübi kood. Võimalikud väärtused:  
| Type code of the message. The possible values are:  
* 13 - kreeditori info,  
* 13 - information for creditors,  
* 20 - inkasso info (mõeldud kreeditori inkasso partneritele).  
* 20 - information for debt collections (for creditors' collection partners).  


Kui Krediidiinfoga pole teisiti kokku lepitud, siis kasutada väärtuseks 13.
Use the value 13, unless agreed otherwise.
|-
|-
| <b>Väljundparameeter:</b>
| <b>Output parameter:</b>
| 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 (võib tulevikus juurde tulla):  
| The value is 0, if the request succeeds. If the value is negative, then it is an error code. Possible values of error codes:  
* -20201 - parameetrile ''clientCode'' vastavat klienti krediidihaldusest ei leitud. Kas kliendikood on vigane või siis ei ole kreeditor antud kliendi infot krediidihaldusesse saatnud.  
* -20201 - the client with parameter ''clientCode'' was not found in credit risk management. Client code is either incorrect or the creditor has not sent the information about the client to credit risk management.  
* -20202 - kasutatud parameetri ''type'' väärtust ei ole lubatud kasutada.
* -20202 - the value of the parameter ''type'' is not allowed to use.
|}
|}


= Arendamine =
= Development =
 
Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:


* Autentimise meetod: ''Basic Authentication''
Sample user is created for the development of interface integration. 
* Kasutajanimi: ''30546''
* Parool: ''soapdemo''


Näidiskasutaja korral saab meetodi ''getOverview'' parameetril ''clientCode'' olla vaid kolm järgmist väärtust:
* Authentication method: ''Basic Authentication''
* User name: ''30546''
* Password: ''soapdemo''


* ''full'' - tagastatakse [[debtor_cmdata_example_full.xml|näidis-XML]], kus on täidetud kõik märgendid
Method ''getOverview'' parameter ''clientCode'' gives three values:
* ''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 Krediidiinfo krediidihalduse andmebaasis.


* ''full'' - [[debtor_cmdata_example_full.xml|sample-XML]] will be returned, where all tags are included
* ''minimal'' - [[debtor_cmdata_example_minimal.xml|sample-XML]] will be returned, where minimal tags are included.
* ''none'' - [[debtor_cmdata_example_none.xml|empty XML]] will be returned, if the requested client does not exist in the credit management database.


= Näide PHP-s =
= Example in PHP =




Line 91: Line 93:
<?php
<?php
/**
/**
  * Example of using Krediidiinfo AS SOAP interface KiCreditManagement.  
  * Example of using CREDITINFO EESTI AS SOAP interface KiCreditManagement.  
  *  
  *  
  * 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 Krediidiinfo AS in order to run this program.
  * to contact with Creditinfo Eesti AS in order to run this program.
  *  
  *  
  * @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditManagement
  * @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditManagement
  * @author Rait Kapp <rait.kapp@experian.com>
  * @author Rait Kapp <rait.kapp@creditinfo.ee>
  * @created 16.09.2010
  * @created 16.09.2010
  */
  */

Latest revision as of 14:09, 6 December 2016

Flag of Estonia.svg eesti keeles

Introduction

KiCreditManagement is the name of a Web Service based on SOAP protocol.

WSDL

KiCreditManagement WDSL is located at http://services.krediidiinfo.ee/KiCreditManagement.wsdl.


Methods

getOverview

Requesting events of client's credit risk management and reminder management.

Name Type Description
Input parameter: clientCode xs:string Client code in creditor's information system.
Output parameter: xml xs:string Response in XML format. XML layout is located at http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd. See an example: debtor_cmdata_example.xml. An empty tag debtor will be given in XML, if the requested client does not exist in the credit management database. (see example)!

sendProceedingInfo

Sending information about customers to credit risk management.

Name Type Description
Input parameter: clientCode xs:string Client code in creditor's information system.
text xs:string Content of the message.
type xs:int Type code of the message. The possible values are:
  • 13 - information for creditors,
  • 20 - information for debt collections (for creditors' collection partners).

Use the value 13, unless agreed otherwise.

Output parameter: resultCode xs:int The value is 0, if the request succeeds. If the value is negative, then it is an error code. Possible values of error codes:
  • -20201 - the client with parameter clientCode was not found in credit risk management. Client code is either incorrect or the creditor has not sent the information about the client to credit risk management.
  • -20202 - the value of the parameter type is not allowed to use.

Development

Sample user is created for the development of interface integration.

  • Authentication method: Basic Authentication
  • User name: 30546
  • Password: soapdemo

Method getOverview parameter clientCode gives three values:

  • full - sample-XML will be returned, where all tags are included
  • minimal - sample-XML will be returned, where minimal tags are included.
  • none - empty XML will be returned, if the requested client does not exist in the credit management database.

Example in PHP

<?php
/**
 * Example of using CREDITINFO EESTI AS SOAP interface KiCreditManagement. 
 * 
 * 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 http://services.krediidiinfo.ee/wiki/index.php/KiCreditManagement
 * @author Rait Kapp <rait.kapp@creditinfo.ee>
 * @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);

?>
Retrieved from "https://services.krediidiinfo.ee/wiki/index.php?title=KiCreditManagement_en&oldid=787"