Späť na dokumentáciu

SDK a knižnice

Oficiálne klientske knižnice na integráciu FirmAPI do vašej aplikácie za pár minút.

PHP SDK

PHP 8.1+

Oficiálny PHP klient pre FirmAPI. Vyžaduje PHP 8.1+ a podporuje Laravel auto-discovery.

Inštalácia

composer require firmapi/php-sdk

Rýchly štart

Lookup by ICO

use FirmApi\Client;

// Create a client with your API key
$client = new Client('your-api-key');

// Look up a company by ICO
$company = $client->company->byIco('51636549');

echo $company->name;         // "Version Two s. r. o."
echo $company->legal_form;    // "Spolocnost s rucenim obmedzenym"
echo $company->address->city; // "Bratislava"

Search

// Search by name
$results = $client->search->byName('Version Two');

foreach ($results as $company) {
    echo $company->ico . ' - ' . $company->name;
}

// Autocomplete (Select2-compatible)
$suggestions = $client->search->autocomplete('vers', limit: 5);

Batch Lookup

// Batch lookup by ICO (Starter plan+)
$batch = $client->batch->byIco([
    '51636549',
    '12345678',
    '87654321',
]);

echo $batch->found;     // 2
echo $batch->not_found; // 1

Všetky dostupné metódy

Metóda Popis Návratový typ
$client->company->byIco($ico) Vyhľadanie firmy podľa IČO (identifikačné číslo) Company
$client->company->byId($id) Vyhľadanie firmy podľa interného ID Company
$client->company->byOrsrId($id) Vyhľadanie firmy podľa ORSR ID Company
$client->search->byName($name) Vyhľadávanie firiem podľa názvu Company[]
$client->search->byIco($ico) Vyhľadávanie firiem podľa čiastočného IČO Company[]
$client->search->autocomplete($q) Automatické dopĺňanie (kompatibilné so Select2) AutocompleteResult[]
$client->search->advanced([...]) Rozšírené vyhľadávanie podľa viacerých polí Company[]
$client->batch->byIco([...]) Starter+ Hromadné vyhľadávanie podľa viacerých IČO BatchResult
$client->batch->byNames([...]) Starter+ Hromadné vyhľadávanie podľa viacerých názvov BatchResult
$client->account->usage() Štatistiky spotreby za aktuálne obdobie Usage
$client->account->quota() Zostávajúca kvóta za aktuálne obdobie Quota
$client->account->history($days) História spotreby UsageHistory

JavaScript / TypeScript SDK

TypeScript

Oficiálny JavaScript klient pre FirmAPI. Funguje v Node.js aj moderných prehliadačoch s plnou podporou TypeScript.

Inštalácia

npm install firmapi

Rýchly štart

Lookup by ICO

import { FirmApi } from 'firmapi';

// Create a client with your API key
const client = new FirmApi('your-api-key');

// Look up a company by ICO
const company = await client.company.byIco('51636549');

console.log(company.name);         // "Version Two s. r. o."
console.log(company.legalForm);    // "Spolocnost s rucenim obmedzenym"
console.log(company.address.city); // "Bratislava"

Search

// Search by name
const results = await client.search.byName('Version Two');

for (const company of results) {
    console.log(`${company.ico} - ${company.name}`);
}

// Autocomplete (Select2-compatible)
const suggestions = await client.search.autocomplete('vers', { limit: 5 });

Batch Lookup

// Batch lookup by ICO (Starter plan+)
const batch = await client.batch.byIco([
    '51636549',
    '12345678',
    '87654321',
]);

console.log(batch.found);    // 2
console.log(batch.notFound); // 1

Všetky dostupné metódy

Metóda Popis Návratový typ
client.company.byIco(ico) Vyhľadanie firmy podľa IČO (identifikačné číslo) Promise<Company>
client.company.byId(id) Vyhľadanie firmy podľa interného ID Promise<Company>
client.company.byOrsrId(id) Vyhľadanie firmy podľa ORSR ID Promise<Company>
client.search.byName(name) Vyhľadávanie firiem podľa názvu Promise<Company[]>
client.search.byIco(ico) Vyhľadávanie firiem podľa čiastočného IČO Promise<Company[]>
client.search.autocomplete(q) Automatické dopĺňanie (kompatibilné so Select2) Promise<AutocompleteResult[]>
client.search.advanced({...}) Rozšírené vyhľadávanie podľa viacerých polí Promise<Company[]>
client.batch.byIco([...]) Starter+ Hromadné vyhľadávanie podľa viacerých IČO Promise<BatchResult>
client.batch.byNames([...]) Starter+ Hromadné vyhľadávanie podľa viacerých názvov Promise<BatchResult>
client.account.usage() Štatistiky spotreby za aktuálne obdobie Promise<Usage>
client.account.quota() Zostávajúca kvóta za aktuálne obdobie Promise<Quota>
client.account.history(days) História spotreby Promise<UsageHistory>