KiCompany

In English

Tutvustus

KiCompany on SOAP protokollil põhinev Creditinfo AS veebiteenus ettevõtete, mittetulundusühingute ja riigiasutuste põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi firmapäringu funktsionaalsust.

WSDL

KiCompany WSDL asub aadressil http://services.krediidiinfo.ee/KiCompany.wsdl.

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: http://services.krediidiinfo.ee/KiCompanyLit.wsdl. See erineb varasemast WSDL-ist selle poolest, et RPC/encode asemel kasutatakse RPC/litteral-i.

Meetodid

getName

Ettevõtte nime pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	Ettevõtte äriregistri kood.
Väljundparameeter:	name	xs:string	Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri, ettevõtte äriregistrikood vigane vms), siis on väljundparameetri väärtuseks tühistring.

getRegistryName

Ettevõtte Äriregistri pika nime pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	Ettevõtte äriregistri kood.
Väljundparameeter:	name	xs:string	Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri), siis on väljundparameetri väärtuseks tühistring.	Vigase registrikoodi korral tagastatakse viga -20501 (Invalid registry code value)

findCompanies

Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	name	xs:string	Ettevõtte nimi või nime algus
	count	xs:int	Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla. (Meetod ei tagasta korraga rohkem kui 100 ettevõtet)
Väljundparameeter:	companies	ResultCompanyIDDataArray	Indekseeritud massiiv, mille elementideks on ResultCompanyIDData tüüpi elemendid.

ResultCompanyIDData on kirje järgmise struktuuriga:

Nimi	Tüüp	Kirjeldus
regCode	xs:string	Ettevõtte äriregistri kood
name	xs:string	Ettevõtte nimi.

getBasicData

Ettevõtte põhiandmete pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	Ettevõtte äriregistri kood.
Väljundparameeter:	data	CompanyBasicDataType	Kirje ettevõtte andmetega.

Kui regCode-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyBasicDataType tüüpi kirje järgmise struktuuriga:

Nimi	Tüüp	Kirjeldus
regCode	xs:string	ettevõtte äriregistri kood
name	xs:string	ettevõtte nimi.
street	xs:string	tänava nimi turunduseks kasutatavas postiaadressis
postCode	xs:string	posti indeksi number turunduseks kasutatavas postiaadressis
city	xs:string	linna nimi turunduseks kasutatavas postiaadressis
legalStreet	xs:string	tänava nimi juriidilises aadressis
legalPostCode	xs:string	posti indeksi number juriidilises aadressis
legalCity	xs:string	linnanimi juriidilises aadressis
phones	xs:string	telefonide numbrid
faxes	xs:string	fakside numbrid
web	xs:string	interneti kodulehekülje URL
emails	xs:string	e-posti aadressid
legalForm	xs:string	juriidiline vorm
shareCapital	xs:int	osakapitali suurus
shareCapitalCur	xs:string	valuuta tähis, milles on osakapitali suurus antud
regTime	xs:string	ettevõtte registreerimise aeg Äriregistris. Formaat: yyyy-mm-dd
regPlace	xs:string	registriosakonna nimetus kus ettevõte registreeriti
activities	xs:string	ettevõtte tegevusalade loetelu. Iga tegevusala ees on string '* ' (tärn ja tühik). Alates 29.07.2011 on väärtuseks tühistring.
status	xs:string	äriregistri staatuse nimetus

getContactData

Ettevõtte kontaktandmete pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	ettevõtte äriregistri kood.
Väljundparameeter:	data	CompanyContactDataType	kirje kontaktandmetega

Kui regCode-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyContactDataType tüüpi kirje on järgmise struktuuriga:

Nimi	Tüüp	Kirjeldus
street	xs:string	tänava nimi turunduseks kasutatavas postiaadressis
postCode	xs:string	posti indeksi number turunduseks kasutatavas postiaadressis
city	xs:string	linna nimi turunduseks kasutatavas postiaadressis
phones	xs:string	telefonide numbrid
faxes	xs:string	fakside numbrid
web	xs:string	interneti kodulehekülje URL
emails	xs:string	e-posti aadressid

getLegalPostAddress

Ettevõtte juriidilise aadressi pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	ettevõtte äriregistri kood.
Väljundparameeter:	data	CompanyPostAddressType	kirje juriidilise aadressi andmetega

Kui regCode-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyPostAddressType tüüpi kirje on järgmise struktuuriga:

Nimi	Tüüp	Kirjeldus
street	xs:string	tänava nimi
postCode	xs:string	indeks
city	xs:string	linn

isRegCodeValid

Ettevõtte äriregistri korrektsuse kontrollimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	Ettevõtte äriregistri kood
Väljundparameeter:	isValid	xs:boolean	Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige.

getVATNo

Ettevõtte käibemaksukohustuslase numbri pärimine.

	Nimi	Tüüp	Kirjeldus
Sisendparameetrid:	regCode	xs:string	Ettevõtte äriregistri kood.
Väljundparameeter:	vatNo	xs:string	KMK number. Kui KMK number ei kehti või ettevõte ei ole käibemaksukohuslane, siis tagastatakse tühistring. Probleemide korral ühendumisel Maksuametiga tagastatakse viga -20502 (Error connecting to Tax Board)

Veakoodid

-10231 No company found!

Creditinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.

(vt lisaks üldiseid veakoode)

Programmi näidis PHP-s

Järgnevalt on toodud PHP-s kirjutatud KiCompany veebiteenuse kasutamise näide.

<?php
/**
 * Example of using KiCompany web service of Creditinfo AS
 * 
 * @author Rait Kapp <rait@creditinfo.ee>
 * @created 15.02.2011
 */
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany'; 


$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' => 'ISO-8859-13'
               );


$client = new SoapClient($wsdl_url, $params);


$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$data = $client->getBasicData($regCode);
echo "Aadress: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
    echo "Äriregistri kood {$regCode} on vigane.\n";
} else {
    echo "Äriregistri kood {$regCode} on korrektne\n";
}

?>

Programmi väljund:

Array
(
    [0] => stdClass Object
        (
            [regCode] => 90006012
            [name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
        )

    [1] => stdClass Object
        (
            [regCode] => 10704587
            [name] => KREDIIDI JÄRELVALVE OÜ
        )

    [2] => stdClass Object
        (
            [regCode] => 11626688
            [name] => KREDIIDIBÜROO OÜ
        )

)
Äriregistri kood 10256137 kuulub ettevõttele CREDITINFO EESTI AS
Aadress: Narva mnt 5 10117 Tallinn
Äriregistri kood 10256136 on vigane.

HTTP päringute näidised

Failis kiCompany_request_examples.zip on KiCompany HTTP päringute ja päringu vastuste näidised. Kui KiCompany integreeritakse süsteemi saates otse HTTP päringuid, siis HTTP vastuse parsimisel kasutada XML vahendeid. Mitte käsitleda HTTP vastuseid kui stringe ja parsida neid nö käsitsi. Kui Creditinfo uuendab SOAP serveri tarkvara, siis võib vastuse sõnumi kuju muutuda.