KiCompanyBasic

From services.krediidiinfo.ee
Revision as of 14:33, 29 March 2010 by Rait (talk | contribs) (Tutvustus: täpsustus tasuta päringute mahu kohta.)
Jump to: navigation, search

Tutvustus

KiCompanyBasic on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete registrikoodide pärimiseks ja kontrollimiseks. KiCompanyBasic päringud on tasuta kuni 500 päringut kuus.

WSDL

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

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.

findCompanies

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

Nimi Tüüp Kirjeldus
Sisendparameetrid: regCode xs:string Ettevõtte äriregistri kood
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.

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.

Näidisprogramm PHP-s

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

<?php
/**
 * Krediidiinfo KiCompanyBasic veebiteenuse kasutamise näidis.
 */
$param = array('encoding'=>'ISO-8859-13');
$client = new SoapClient('http://services.krediidiinfo.ee/KiCompanyBasic.wsdl', $param);

$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";

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

Programmi väljund:


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

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

    [2] => Array
        (
            [regCode] => 10256137
            [name] => KREDIIDIINFO AS
        )

)
Äriregistri kood 10256137 kuulub ettevõttele KREDIIDIINFO AS
Äriregistri kood on vigane.