Swiftyper API
Úlohou API je sprístupnenie softvérového rozhrania na prístup k službám súvisiacimi s vyhľadaním miest, právnických osôb a SZČO.
Služba je postavená na REST architektúre. JSON je výstupom všetkých odpovedí z API aj vrátane chýb. V prípade použitia API knižnice prevedieme odpoveď na objekt programovacieho jayzka knižnice.
Knižnice
| PHP | composer require swiftyper/swiftyper-php |
|---|---|
| Node.js | npm install swiftyper-node |
https://api.swiftyper.skAutentifikácia
Napojenie na Swiftyper API prebieha vyžiadaním API kľúča cez hlavičku
X-Swiftyper-API-Key alebo parameter api_key.
Spravovať API kľúče môžete cez Váš používateľský účet.
API kľúče sú predvolene neobmedzené. Neobmedzené kľúče nie sú bezpečné, pretože ich môže používať ktokoľvek a odkiaľkoľvek. Pre produkčné aplikácie odporúčame nastaviť obmedzenia API kľúča nakoľko pomáhajú zabrániť neoprávnenému použitiu a vyčerpávaniu kvót. Obmedzenia určujú, ktoré webové stránky alebo IP adresy môžu používať API kľúč.
Všetky API požiadavky musia byť smerované prostredníctvom protokolu HTTPS. Požiadavky smerované cez protokol HTTP nebudú spracované. Pri všetkých požiadavkách je nevyhnutná autentifikácia.
curl -X POST https://api.swiftyper.sk/v1/places/regions \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d country=SK
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);Vo všetkých príkladoch v tejto dokumentácii uvádzame testovací API kľúč, takže môžete ihneď vyskúšať ktorýkoľvek príklad.
Chybové kódy
Používame bežné HTTP kódy odpovedí na indikáciu úspechu alebo neúspechu API požiadavky. Kódy v rozsahu 2xx všeobecne označujú úspech, kódy v rozsahu 4xx indikujú chybu, ktorá vznikla na základe poskytnutých informácií (napr. chýajúci požadovaný parameter, presiahnutie limitu atď.). Kódy v rozsahu 5xx indikujú chybu na našich serveroch.
Atribúty
-
type
Typ výstupnej chyby, môže byť
invalid_request,api_error -
message
Správa obsahujúca ďalšie podrobnosti o chybe
-
code
Kódové označenie výstupnej chyby
-
param
Parameter, ktorého sa chyba týka, ak je chyba špecifická pre daný parameter
Stavové kódy HTTP
| 200 - OK | Štandardná odpoveď pre úspešnú HTTP požiadavku. |
|---|---|
| 400 - Bad Request | Požiadavka nemôže byť vykonaná, pretože bola syntakticky nesprávne zapísaná. |
| 401 - Unauthorized | Požadovaný API kľúč nie je platný. |
| 402 - Request Failed | Zlyhanie požiadavky. |
| 404 - Not Found | Požadovaná položka nebola nájdená. |
| 500, 502, 503, 504 - Server Errors | Neočakávaný problém na našich serveroch. |
Chyby
| invalid_request | Ak má vaša žiadosť neplatné parametre. |
|---|---|
| api_error | Chyba API pokrýva akýkoľvek iný typ problému (napr. dočasný problém s našimi servermi) pričom by sa mali objavovať iba veľmi výnimočne. |
| invalid_parameter | Ak je zadaná nesprávna hodnota parametru. |
|---|---|
| unexpected_parameter | Pokiaľ použijete neexistujúci parameter požiadavky. |
| over_query_limit | Keď presiahnete mesačný limit na vyhľadávanie. |
| rate_limit | Keď posielate veľké množstvo žiadostí v krátkom časovom intervale. |
| missing | Keď hľadáte detail neexistujúceho miesta alebo právnickej osoby. |
| restricted | Ak ste pre API kľúč obmedzili prístup pre konkrétnu doménu alebo IP adresu ktorá sa nezhoduje s hlavičkou
referer, alebo vyhľadávate v oblasti ktorú ste nepovolili.
|
Odchytávanie chýb
Naše API knižnice môžu vyvolať výnimky z mnohých dôvodov, napríklad z dôvodu prekročenia mesačného limitu, neplatných parametrov, chýb autentifikácie a nedostupnosti siete. Odporúčame vždy sa pokúsiť elegantne zvládnuť výnimky z nášho API.
try {
// ...
} catch (\Swiftyper\Error\InvalidRequest $e) {
// V prípade zadania neplatných parametrov
$body = $e->getJsonBody();
$err = $body['error'];
print('Stavový kód:' . $e->getHttpStatus() . "\n");
print('Typ chyby:' . $err['type'] . "'\n");
print('Kód chyby:' . $err['code'] . "'\n");
print('Parameter:' . $err['param'] . "\n");
print('Popis chyby:' . $err['message'] . "\n");
} catch (\Swiftyper\Error\Authentication $e) {
// V prípade neúspešnej autentifikácie
} catch (\Swiftyper\Error\Quota $e) {
// V prípade presiahnutia mesačného limitu
} catch (\Swiftyper\Error\ApiConnection $e) {
// V prípade zlyhania sieťovej komunikácie
} catch (Exception $e) {
// V prípade inej chyby nesúvisiacej so službou Swiftyper
}// Poznámka: Node.js API nevyvoláva výnimky (okrem prípradu nezadaných povinných parametrov)
//
// Chyba je definovaná ako prvý argument callbacku:
// swiftyper.places.query({...}, function(err, result) {});
//
// je možné použiť aj Promise:
// swiftyper.places.query({...}).then(
// function(result) {},
// function(err) {}
// );
switch (err.type) {
case 'SwiftyperUnexpectedParameterError':
case 'SwiftyperInvalidParameterError':
// V prípade zadania neplatných parametrov
break;
case 'SwiftyperInvalidApiKeyError':
// V prípade neúspešnej autentifikácie
break;
case 'SwiftyperQuotaError':
// V prípade presiahnutia mesačného limitu
break;
case 'SwiftyperRestrictedError':
// V prípade vyhľadávania vo Vami nepovolenom obsahu
break;
case 'SwiftyperAPIError':
// V prípade chyby súvisiacou so službou swiftyper
break;
case 'SwiftyperConnectionError':
// V prípade zlyhania sietovej komunikácie
break;
}Dostupné subjekty
Údaje čerpáme z referenčných registrov verejnej správy. Informácie o právnických osobách sú pravideľne aktualizované zo zdrojových registrov (napr. obchodný register, živnostenský register).
Údaje aktualizujeme v závislosti od dostupnosti vydania nových datasetov - zvyčajne raz denne.
Aktuálne poskytujeme register právnických osôb a SZČO a ich kontaktné a fakturačné údaje týchto krajin:
PRIBLIŽNÝ ODHAD ÚDAJOV
-
Slovenská republika (SK)
1 600 000+ právnických osôb a SZČO
-
Česká republika (CZ)
1 000 000+ právnických osôb
Dostupné krajiny
Údaje čerpáme z referenčných registrov verejnej správy. Informácie o adresách sú pravideľne aktualizované zo zdrojových registrov.
Údaje aktualizujeme v závislosti od dostupnosti vydania nových datasetov - zvyčajne raz denne.
Aktuálne poskytujeme adriesy a ich metadáta týchto krajin:
PRIBLIŽNÝ ODHAD ÚDAJOV
-
Slovenská republika (SK)
1 700 000+ adries
-
Česká republika (CZ)
3 000 000+ adries
-
Poľská republika (PL)
7 900 000+ adries
-
Rakúsko (AT)
2 500 000+ adries
-
Švajčiarsko (CH)
1 600 000+ adries
Popis atribútov číselníka
Atribúty
-
place_id string
Unikátny identifikátor miesta
-
name string
Názov
-
object string
Typ objektu, môže byť
region,county -
formatted_country string
Názov krajiny
-
country string
Kód krajiny (dvojmiestny alfabetický kód ISO 3166)
[
{
"place_id": "sk_Go1acmQpVyAvyPD1oEa__w",
"name": "Bratislava I",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_k7donKVQqPY_baKM5EdfKQ",
"name": "Bratislava II",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_XNSv41OM9WfIw1LfEGBpaA",
"name": "Bratislava III",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_wh6d-znIN4L9VIx93u5jsA",
"name": "Bratislava IV",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_dWKI0wFZwY738AAE_BwYfg",
"name": "Bratislava V",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]
Swiftyper\Collection: [
Swiftyper\SwiftyperObject: {
"place_id": "sk_Go1acmQpVyAvyPD1oEa__w",
"name": "Bratislava I",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_k7donKVQqPY_baKM5EdfKQ",
"name": "Bratislava II",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_XNSv41OM9WfIw1LfEGBpaA",
"name": "Bratislava III",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_wh6d-znIN4L9VIx93u5jsA",
"name": "Bratislava IV",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_dWKI0wFZwY738AAE_BwYfg",
"name": "Bratislava V",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]
[
{
"place_id": "sk_Go1acmQpVyAvyPD1oEa__w",
"name": "Bratislava I",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_k7donKVQqPY_baKM5EdfKQ",
"name": "Bratislava II",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_XNSv41OM9WfIw1LfEGBpaA",
"name": "Bratislava III",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_wh6d-znIN4L9VIx93u5jsA",
"name": "Bratislava IV",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_dWKI0wFZwY738AAE_BwYfg",
"name": "Bratislava V",
"object": "county",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]
Číselník krajov
Zobrazenie základného zoznamu obsahujúceho kraje konkrétnej krajiny. Zobrazenie číselníku sa nepočíta do mesačého limitu. Číselníky sa zobrazujú vždy celé.
Parametre
-
country povinné string, obsahujúci
dostupnú krajinuKrajina ktorej zoznam krajov sa zobrazí
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba.
POST https://api.swiftyper.sk/v1/places/regions\Swiftyper\Places::regions();swiftyper.places.regions();curl -X POST https://api.swiftyper.sk/v1/places/regions \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d country=SK
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::regions(array (
'country' => 'SK',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.regions({
country: 'SK'
}, function(error, results) {
// asynchrónne volanie
});[
{
"place_id": "sk_qlJ5jhetM_G5lt1SjD5auw",
"name": "Bratislavský kraj",
"object": "region",
"country": "SK"
},
{
"place_id": "sk_OsZo7TUYA53C8dspJk1DhQ",
"name": "Trnavský kraj",
"object": "region",
"country": "SK"
},
{
"place_id": "sk_qSHKHJWJevelNSQKcyqJZQ",
"name": "Nitriansky kraj",
"object": "region",
"country": "SK"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\SwiftyperObject: {
"place_id": "sk_qlJ5jhetM_G5lt1SjD5auw",
"name": "Bratislavský kraj",
"object": "region",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_OsZo7TUYA53C8dspJk1DhQ",
"name": "Trnavský kraj",
"object": "region",
"country": "SK"
},
Swiftyper\SwiftyperObject: {
"place_id": "sk_qSHKHJWJevelNSQKcyqJZQ",
"name": "Nitriansky kraj",
"object": "region",
"country": "SK"
},
{...},
{...}
][
{
"place_id": "sk_qlJ5jhetM_G5lt1SjD5auw",
"name": "Bratislavský kraj",
"object": "region",
"country": "SK"
},
{
"place_id": "sk_OsZo7TUYA53C8dspJk1DhQ",
"name": "Trnavský kraj",
"object": "region",
"country": "SK"
},
{
"place_id": "sk_qSHKHJWJevelNSQKcyqJZQ",
"name": "Nitriansky kraj",
"object": "region",
"country": "SK"
},
{...},
{...}
]Číselník okresov
Zobrazenie základného zoznamu obsahujúceho okresy konkrétnej krajiny. Zobrazenie číselníku sa nepočíta do mesačého limitu. Číselníky sa zobrazujú vždy celé.
Parametre
-
country povinné string, obsahujúci
dostupnú krajinuKrajina ktorej zoznam okresov sa zobrazí
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba.
POST https://api.swiftyper.sk/v1/places/counties\Swiftyper\Places::counties();swiftyper.places.counties();curl -X POST https://api.swiftyper.sk/v1/places/counties \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d country=CZ
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::counties(array (
'country' => 'CZ',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.counties({
country: 'CZ'
}, function(error, results) {
// asynchrónne volanie
});[
{
"place_id": "cz_yrWVCzCv7HwQpBYQQwTQOw",
"name": "Hlavní město Praha",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_25DCP690H_QSJrSkV0C9vA",
"name": "Benešov",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_Mur5F_iluktlE89UOUnR2w",
"name": "Beroun",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\SwiftyperObject: {
"place_id": "cz_yrWVCzCv7HwQpBYQQwTQOw",
"name": "Hlavní město Praha",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
Swiftyper\SwiftyperObject: {
"place_id": "cz_25DCP690H_QSJrSkV0C9vA",
"name": "Benešov",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
Swiftyper\SwiftyperObject: {
"place_id": "cz_Mur5F_iluktlE89UOUnR2w",
"name": "Beroun",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
][
{
"place_id": "cz_yrWVCzCv7HwQpBYQQwTQOw",
"name": "Hlavní město Praha",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_25DCP690H_QSJrSkV0C9vA",
"name": "Benešov",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_Mur5F_iluktlE89UOUnR2w",
"name": "Beroun",
"object": "county",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
]Číselník miest a obcí
Zobrazenie základného zoznamu obsahujúceho mestá a obce konkrétnej krajiny. Zobrazenie číselníku sa nepočíta do mesačého limitu. Číselníky sa zobrazujú vždy celé.
Parametre
-
country povinné string, obsahujúci
dostupnú krajinuKrajina ktorej zoznam miest a obcí sa zobrazí
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba.
POST https://api.swiftyper.sk/v1/places/municipalities\Swiftyper\Places::municipalities();swiftyper.places.municipalities();curl -X POST https://api.swiftyper.sk/v1/places/municipalities \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d country=SK
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::municipalities(array (
'country' => 'SK',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.municipalities({
country: 'SK'
}, function(error, results) {
// asynchrónne volanie
});[
{
"place_id": "sk_Mgxp6-WiQ1WVAIeUA8pVHA",
"highlight": "Javorina",
"municipality": "Javorina",
"county": "Kežmarok",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": {
"lat": 49.13994,
"lng": 20.5353399
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_0gIB-dXD-SdXa8SCHcuGLw",
"highlight": "Prešov",
"municipality": "Prešov",
"county": "Prešov",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": {
"lat": 49.0018324,
"lng": 21.2393119
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\Municipality: {
"place_id": "sk_Mgxp6-WiQ1WVAIeUA8pVHA",
"highlight": "Javorina",
"municipality": "Javorina",
"county": "Kežmarok",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 49.13994,
"lng": 20.5353399
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Municipality: {
"place_id": "sk_0gIB-dXD-SdXa8SCHcuGLw",
"highlight": "Prešov",
"municipality": "Prešov",
"county": "Prešov",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 49.0018324,
"lng": 21.2393119
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
][
{
"place_id": "sk_Mgxp6-WiQ1WVAIeUA8pVHA",
"highlight": "Javorina",
"municipality": "Javorina",
"county": "Kežmarok",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": {
"lat": 49.13994,
"lng": 20.5353399
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_0gIB-dXD-SdXa8SCHcuGLw",
"highlight": "Prešov",
"municipality": "Prešov",
"county": "Prešov",
"region": "Prešovský kraj",
"object": "municipality",
"latlng": {
"lat": 49.0018324,
"lng": 21.2393119
},
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Poštové adresy
Prostredníctvom služby Swiftyper Places API je možné vyhľadať viacero druhov miest - adresu, ulicu, obec a poštové smerovacie číslo.
Popis atribútov
Atribúty
-
place_id string
Unikátny identifikátor miesta
-
highlight string
Zvýraznená časť zhodná s dopytom vyhľadávania
-
formatted_address string
Naformátovaná adresa miesta
-
street string
Názov ulice
-
formatted_street string
Naformátovaná ulica
-
street_number string
Súpisné číslo
-
building_number string
Orientačné číslo
-
formatted_number string
Naformátované číslo ulice
-
postal_code string
Poštové smerovacie číslo
-
municipality string
Názov obce
-
district string
Názov časti obce
-
county string
Názov okresu
-
region string
Názov kraju
-
latlng object
Geokódovaná zemepisná šírka a dĺžka
vnorené atribúty
-
lat double
-
lng double
-
-
object string
Typ objektu, môže byť
address,street,municipality,postal_code -
formatted_country string
Názov krajiny
-
country string
Kód krajiny (dvojmiestny alfabetický kód ISO 3166)
{
"place_id": "sk_JHJ0hYOM_0BZr9s68eVjNA",
"highlight": "<em>Einsteinova</em> 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_address": "Einsteinova 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_street": "Einsteinova 3754/25",
"street_number": "3754",
"building_number": "25",
"formatted_number": "3754/25",
"municipality": "Bratislava-Petržalka",
"postal_code": "85101",
"street": "Einsteinova",
"region": "Bratislavský kraj",
"county": "Bratislava V",
"district": null,
"latlng": {
"lat": 48.12983272,
"lng": 17.10609009
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
Swiftyper\Address: {
"place_id": "sk_JHJ0hYOM_0BZr9s68eVjNA",
"highlight": "<em>Einsteinova</em> 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_address": "Einsteinova 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_street": "Einsteinova 3754/25",
"street_number": "3754",
"building_number": "25",
"formatted_number": "3754/25",
"municipality": "Bratislava-Petržalka",
"postal_code": "85101",
"street": "Einsteinova",
"region": "Bratislavský kraj",
"county": "Bratislava V",
"district": null,
"latlng": Swiftyper\SwiftyperObject: {
"lat": 48.12983272,
"lng": 17.10609009
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
{
"place_id": "sk_JHJ0hYOM_0BZr9s68eVjNA",
"highlight": "<em>Einsteinova</em> 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_address": "Einsteinova 3754/25, 85101 Bratislava-Petržalka, Slovenská republika",
"formatted_street": "Einsteinova 3754/25",
"street_number": "3754",
"building_number": "25",
"formatted_number": "3754/25",
"municipality": "Bratislava-Petržalka",
"postal_code": "85101",
"street": "Einsteinova",
"region": "Bratislavský kraj",
"county": "Bratislava V",
"district": null,
"latlng": {
"lat": 48.12983272,
"lng": 17.10609009
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
Vyhľadanie adresy
Vyhľadanie poštových adries cez akúkoľvek časť adresy.
Parametre
-
query povinné
Všeobecný výraz vyhľadávania
-
street string
Výraz na došpecifikovanie názvu a čísla ulice
-
municipality string
Výraz na došpecifikovanie názvu obce
-
postal_code string
Výraz na došpecifikovanie poštového smerovacieho čísla
-
context string[]
Nastavenie oblastí pre vyhľadávanie (kľúč
place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec -
contextType string
Nastavenie typu vyhľadávacieho kontextu. Použite
strictak chcete vyhľadávať adresu s ďalšími zadanými parametrami (street,municipalityalebopostal_code) alebopreferencepokiaľ chete adresy zo zadaného miesta uprednostniť -
around_latlng string
Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte
latitude,longitudenapr.49.1992988,18.8211994 -
around_latlng_via_ip string
Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa
-
country string[], obsahujúci
dostupné krajinyKrajiny v ktorých sa adresa bude vyhľadávať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/places/query\Swiftyper\Places::query();swiftyper.places.query();curl -X POST https://api.swiftyper.sk/v1/places/query \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d query=Ľudovíta Štúra \
-d street="10"
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::query(array (
'query' => 'Ľudovíta Štúra',
'street' => '10',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.query({
query: 'Ľudovíta Štúra',
street: '10',
}, function(error, results) {
// asynchrónne volanie
});[
{
"place_id": "sk_gMmyS5861DBBOlA9j-MZsQ",
"highlight": "<em>Ľ.</em> <em>Štúra</em> 107/<em>10</em>, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_address": "Ľ. Štúra 107/10, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_street": "Ľ. Štúra 107/10",
"street_number": "107",
"building_number": "10",
"formatted_number": "107/10",
"municipality": "Trenčianska Teplá",
"postal_code": "91401",
"street": "Ľ. Štúra",
"region": "Trenčiansky kraj",
"county": "Trenčín",
"district": "Trenčianska Teplá",
"latlng": {
"lat": 48.93217044,
"lng": 18.10914388
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_D72YztX4hh_8KVkY8VfGdQ",
"highlight": "<em>Ľudovíta</em> <em>Štúra</em> 1043/<em>10</em>, 08501 Bardejov, Slovenská republika",
"formatted_address": "Ľudovíta Štúra 1043/10, 08501 Bardejov, Slovenská republika",
"formatted_street": "Ľudovíta Štúra 1043/10",
"street_number": "1043",
"building_number": "10",
"formatted_number": "1043/10",
"municipality": "Bardejov",
"postal_code": "08501",
"street": "Ľudovíta Štúra",
"region": "Prešovský kraj",
"county": "Bardejov",
"district": "Bardejov",
"latlng": {
"lat": 49.30480275,
"lng": 21.2803001
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\Address: {
"place_id": "sk_gMmyS5861DBBOlA9j-MZsQ",
"highlight": "<em>Ľ.</em> <em>Štúra</em> 107/<em>10</em>, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_address": "Ľ. Štúra 107/10, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_street": "Ľ. Štúra 107/10",
"street_number": "107",
"building_number": "10",
"formatted_number": "107/10",
"municipality": "Trenčianska Teplá",
"postal_code": "91401",
"street": "Ľ. Štúra",
"region": "Trenčiansky kraj",
"county": "Trenčín",
"district": "Trenčianska Teplá",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 48.93217044,
"lng": 18.10914388
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Address: {
"place_id": "sk_D72YztX4hh_8KVkY8VfGdQ",
"highlight": "<em>Ľudovíta</em> <em>Štúra</em> 1043/<em>10</em>, 08501 Bardejov, Slovenská republika",
"formatted_address": "Ľudovíta Štúra 1043/10, 08501 Bardejov, Slovenská republika",
"formatted_street": "Ľudovíta Štúra 1043/10",
"street_number": "1043",
"building_number": "10",
"formatted_number": "1043/10",
"municipality": "Bardejov",
"postal_code": "08501",
"street": "Ľudovíta Štúra",
"region": "Prešovský kraj",
"county": "Bardejov",
"district": "Bardejov",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 49.30480275,
"lng": 21.2803001
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
][
{
"place_id": "sk_gMmyS5861DBBOlA9j-MZsQ",
"highlight": "<em>Ľ.</em> <em>Štúra</em> 107/<em>10</em>, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_address": "Ľ. Štúra 107/10, 91401 Trenčianska Teplá, Slovenská republika",
"formatted_street": "Ľ. Štúra 107/10",
"street_number": "107",
"building_number": "10",
"formatted_number": "107/10",
"municipality": "Trenčianska Teplá",
"postal_code": "91401",
"street": "Ľ. Štúra",
"region": "Trenčiansky kraj",
"county": "Trenčín",
"district": "Trenčianska Teplá",
"latlng": {
"lat": 48.93217044,
"lng": 18.10914388
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_D72YztX4hh_8KVkY8VfGdQ",
"highlight": "<em>Ľudovíta</em> <em>Štúra</em> 1043/<em>10</em>, 08501 Bardejov, Slovenská republika",
"formatted_address": "Ľudovíta Štúra 1043/10, 08501 Bardejov, Slovenská republika",
"formatted_street": "Ľudovíta Štúra 1043/10",
"street_number": "1043",
"building_number": "10",
"formatted_number": "1043/10",
"municipality": "Bardejov",
"postal_code": "08501",
"street": "Ľudovíta Štúra",
"region": "Prešovský kraj",
"county": "Bardejov",
"district": "Bardejov",
"latlng": {
"lat": 49.30480275,
"lng": 21.2803001
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Vyhľadanie ulice
Vyhľadanie ulíc na základe názvu.
Parametre
-
query povinné
Všeobecný výraz vyhľadávania
-
municipality
Výraz na došpecifikovanie názvu obce
-
context string[]
Nastavenie oblastí pre vyhľadávanie (kľúč
place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec -
contextType string
Nastavenie typu vyhľadávacieho kontextu. Použite
strictak chcete vyhľadávať adresu s ďalšími zadanými parametrami (municipality) alebopreferencepokiaľ chete adresy zo zadaného miesta uprednostniť -
around_latlng string
Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte
latitude,longitudenapr.49.1992988,18.8211994 -
around_latlng_via_ip string
Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa
-
country string[], obsahujúci
dostupné krajinyKrajiny v ktorých sa adresa bude vyhľadávať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/places/street\Swiftyper\Places::street();swiftyper.places.street();curl -X POST https://api.swiftyper.sk/v1/places/street \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d query=Beethoven
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::street(array (
'query' => 'Beethoven',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.street({
query: 'Beethoven',
}, function(error, results) {
// asynchrónne volanie
});[
{
"place_id": "sk_u6yEYf82daTjyfs3r0Dmbg",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Piešťany",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_crid0VwgyZ5l35sfq328NA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Nitra",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_VobrHYk3JjcQEToxpg9koA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Brno",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_UPav3iy_p9lDBQV-z7mQ3A",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Frýdek-Místek",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\Street: {
"place_id": "sk_u6yEYf82daTjyfs3r0Dmbg",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Piešťany",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Street: {
"place_id": "sk_crid0VwgyZ5l35sfq328NA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Nitra",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Street: {
"place_id": "cz_VobrHYk3JjcQEToxpg9koA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Brno",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Street: {
"place_id": "cz_UPav3iy_p9lDBQV-z7mQ3A",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Frýdek-Místek",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
][
{
"place_id": "sk_u6yEYf82daTjyfs3r0Dmbg",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Piešťany",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_crid0VwgyZ5l35sfq328NA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Nitra",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_VobrHYk3JjcQEToxpg9koA",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Brno",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_UPav3iy_p9lDBQV-z7mQ3A",
"highlight": "<em>Beethoven</em>ova",
"street": "Beethovenova",
"municipality": "Frýdek-Místek",
"object": "street",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...},
{...}
]Vyhľadanie obce
Vyhľadanie obcí na základe názvu.
Parametre
-
query povinné
Hľadaný výraz
-
postal_code string
Výraz na došpecifikovanie poštového smerovacieho čísla
-
context string[]
Nastavenie oblastí pre vyhľadávanie (kľúč
place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec -
contextType string
Nastavenie typu vyhľadávacieho kontextu. Použite
strictak chcete vyhľadávať adresu s ďalšími zadanými parametrami (postal_code) alebopreferencepokiaľ chete adresy zo zadaného miesta uprednostniť -
around_latlng string
Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte
latitude,longitudenapr.49.1992988,18.8211994 -
around_latlng_via_ip string
Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa
-
country string[], obsahujúci dostupné krajiny
Krajiny v ktorých sa obec bude vyhľadávať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/places/municipality\Swiftyper\Places::municipality();swiftyper.places.municipality();curl -X POST https://api.swiftyper.sk/v1/places/municipality \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d query=Jabloň\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::municipality(array (
'query' => 'Jabloň',
));var swiftyper = require("swiftyper")(
"Jabloň"
);
swiftyper.places.municipality(
"Jabloň",
function(error, results) {
// asynchrónne volanie
}
);[
{
"place_id": "sk_yZ4uZvUW--uWo5REzGRTDg",
"highlight": "<em>Jabloň</em> (Humenné, Slovenská republika)",
"municipality": "Jabloň",
"county": "Humenné",
"region": "Prešovský kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_ReIieZEL_M9ePv0DTKR4KQ",
"highlight": "<em>Jabloň</em>ovce (Levice, Slovenská republika)",
"municipality": "Jabloňovce",
"county": "Levice",
"region": "Nitriansky kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_DNe3xu2pGe-JSriIQ8JzCA",
"highlight": "<em>Jablon</em>ná (Příbram, Česká republika)",
"municipality": "Jablonná",
"county": "Příbram",
"region": "Stredočeský kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_97gMCK2gJyyQVdzJo2bg9A",
"highlight": "<em>Jablon</em>né v Podještědí (Liberec, Česká republika)",
"municipality": "Jablonné v Podještědí",
"county": "Liberec",
"region": "Liberecký kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
]Swiftyper\Collection: [
Swiftyper\Municipality: {
"place_id": "sk_yZ4uZvUW--uWo5REzGRTDg",
"highlight": "<em>Jabloň</em> (Humenné, Slovenská republika)",
"municipality": "Jabloň",
"county": "Humenné",
"region": "Prešovský kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Municipality: {
"place_id": "sk_ReIieZEL_M9ePv0DTKR4KQ",
"highlight": "<em>Jabloň</em>ovce (Levice, Slovenská republika)",
"municipality": "Jabloňovce",
"county": "Levice",
"region": "Nitriansky kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\Municipality: {
"place_id": "cz_DNe3xu2pGe-JSriIQ8JzCA",
"highlight": "<em>Jablon</em>ná (Příbram, Česká republika)",
"municipality": "Jablonná",
"county": "Příbram",
"region": "Stredočeský kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
Swiftyper\Municipality: {
"place_id": "cz_97gMCK2gJyyQVdzJo2bg9A",
"highlight": "<em>Jablon</em>né v Podještědí (Liberec, Česká republika)",
"municipality": "Jablonné v Podještědí",
"county": "Liberec",
"region": "Liberecký kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
][
{
"place_id": "sk_yZ4uZvUW--uWo5REzGRTDg",
"highlight": "<em>Jabloň</em> (Humenné, Slovenská republika)",
"municipality": "Jabloň",
"county": "Humenné",
"region": "Prešovský kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_ReIieZEL_M9ePv0DTKR4KQ",
"highlight": "<em>Jabloň</em>ovce (Levice, Slovenská republika)",
"municipality": "Jabloňovce",
"county": "Levice",
"region": "Nitriansky kraj",
"object": "municipality",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "cz_DNe3xu2pGe-JSriIQ8JzCA",
"highlight": "<em>Jablon</em>ná (Příbram, Česká republika)",
"municipality": "Jablonná",
"county": "Příbram",
"region": "Stredočeský kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
{
"place_id": "cz_97gMCK2gJyyQVdzJo2bg9A",
"highlight": "<em>Jablon</em>né v Podještědí (Liberec, Česká republika)",
"municipality": "Jablonné v Podještědí",
"county": "Liberec",
"region": "Liberecký kraj",
"object": "municipality",
"formatted_country": "Česká republika",
"country": "CZ"
},
{...},
{...}
]Vyhľadanie PSČ
Vyhľadanie poštového smerovacieho čísla na základe kódu.
Parametre
-
query povinné
Hľadaný výraz
-
municipality
Výraz na došpecifikovanie názvu obce
-
context string[]
Nastavenie oblastí pre vyhľadávanie (kľúč
place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec -
contextType string
Nastavenie typu vyhľadávacieho kontextu. Použite
strictak chcete vyhľadávať adresu s ďalšími zadanými parametrami (municipality) alebopreferencepokiaľ chete adresy zo zadaného miesta uprednostniť -
around_latlng string
Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte
latitude,longitudenapr.49.1992988,18.8211994 -
around_latlng_via_ip string
Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa
-
country string[], obsahujúci
dostupné krajinyKrajiny v ktorých sa PSČ bude vyhľadávať.
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/places/postal\Swiftyper\Places::postal();swiftyper.places.postal();curl -X POST https://api.swiftyper.sk/v1/places/postal \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d query="01004"
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::postal(array (
'query' => '01004',
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.postal(
"01004",
function(error, results) {
// asynchrónne volanie
}
);[
{
"place_id": "sk_C5Yd8zdpJaPzEBqJWi-KgQ",
"highlight": "<em>01004</em>, Žilina",
"postal_code": "01004",
"municipality": "Žilina",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_kI_VtWzZpL-rE3tx0Ezghg",
"highlight": "<em>01004</em>, Bitarová",
"postal_code": "01004",
"municipality": "Bitarová",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_JgsBii0z2iHkUTQDinNBpA",
"highlight": "<em>01004</em>, Brezany",
"postal_code": "01004",
"municipality": "Brezany",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_N1S0GEoTxnroRafQ5VF1yw",
"highlight": "<em>01004</em>, Hôrky",
"postal_code": "01004",
"municipality": "Hôrky",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...}
]Swiftyper\Collection: [
Swiftyper\PostalCode: {
"place_id": "sk_C5Yd8zdpJaPzEBqJWi-KgQ",
"highlight": "<em>01004</em>, Žilina",
"postal_code": "01004",
"municipality": "Žilina",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\PostalCode: {
"place_id": "sk_kI_VtWzZpL-rE3tx0Ezghg",
"highlight": "<em>01004</em>, Bitarová",
"postal_code": "01004",
"municipality": "Bitarová",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\PostalCode: {
"place_id": "sk_JgsBii0z2iHkUTQDinNBpA",
"highlight": "<em>01004</em>, Brezany",
"postal_code": "01004",
"municipality": "Brezany",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
Swiftyper\PostalCode: {
"place_id": "sk_N1S0GEoTxnroRafQ5VF1yw",
"highlight": "<em>01004</em>, Hôrky",
"postal_code": "01004",
"municipality": "Hôrky",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...}
][
{
"place_id": "sk_C5Yd8zdpJaPzEBqJWi-KgQ",
"highlight": "<em>01004</em>, Žilina",
"postal_code": "01004",
"municipality": "Žilina",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_kI_VtWzZpL-rE3tx0Ezghg",
"highlight": "<em>01004</em>, Bitarová",
"postal_code": "01004",
"municipality": "Bitarová",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_JgsBii0z2iHkUTQDinNBpA",
"highlight": "<em>01004</em>, Brezany",
"postal_code": "01004",
"municipality": "Brezany",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{
"place_id": "sk_N1S0GEoTxnroRafQ5VF1yw",
"highlight": "<em>01004</em>, Hôrky",
"postal_code": "01004",
"municipality": "Hôrky",
"object": "postal_code",
"formatted_country": "Slovenská republika",
"country": "SK"
},
{...}
]Detail miesta
Načítanie podrobností na základe identifikátora miesta. Prostredníctvom identifikátora je možné načítať adresu, ulicu, obec a poštové smerovacie čísla.
Parametre
-
place_id povinné
Identifikátor miesta
Výstup
Výstupom je v prípade platného id objekt s popísanými atribútmi, v opačnom pripade sa zobrazí chyba.
POST https://api.swiftyper.sk/v1/places/{place_id}$ch = \Swiftyper\Places::detail({place_id});
$ch->detail();swiftyper.places.detail({place_id});curl -X POST https://api.swiftyper.sk/v1/places/sk_m16ZZTrfCm2Rfnm6oN7oeA \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y'
\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
$place = \Swiftyper\Places::detail("sk_m16ZZTrfCm2Rfnm6oN7oeA");var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.detail("sk_m16ZZTrfCm2Rfnm6oN7oeA", function(err, charge) {
// asynchrónne volanie
});{
"place_id": "sk_m16ZZTrfCm2Rfnm6oN7oeA",
"highlight": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_address": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_street": "Izabely Textorisovej 4534/1",
"street_number": "4534",
"building_number": "1",
"formatted_number": "4534/1",
"municipality": "Martin",
"postal_code": "03601",
"region": "Žilinský kraj",
"county": "Martin",
"district": "Martin",
"latlng": {
"lat": 49.05245753,
"lng": 18.92395417
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}Swiftyper\Address: {
"place_id": "sk_m16ZZTrfCm2Rfnm6oN7oeA",
"highlight": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_address": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_street": "Izabely Textorisovej 4534/1",
"street_number": "4534",
"building_number": "1",
"formatted_number": "4534/1",
"municipality": "Martin",
"postal_code": "03601",
"region": "Žilinský kraj",
"county": "Martin",
"district": "Martin",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 49.05245753,
"lng": 18.92395417
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}{
"place_id": "sk_m16ZZTrfCm2Rfnm6oN7oeA",
"highlight": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_address": "Izabely Textorisovej 4534/1, 03601 Martin, Slovenská republika",
"formatted_street": "Izabely Textorisovej 4534/1",
"street_number": "4534",
"building_number": "1",
"formatted_number": "4534/1",
"municipality": "Martin",
"postal_code": "03601",
"region": "Žilinský kraj",
"county": "Martin",
"district": "Martin",
"latlng": {
"lat": 49.05245753,
"lng": 18.92395417
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}Reverzné geokódovanie
Vyhľadávanie adresy podľa zemepisných súradníc (GPS, systém WGS84).
Parametre
-
lat povinné
Zemepisná šírka
-
lng povinné
Zemepisná dĺžka
-
jtskX povinné
Súradnica JTSK osi X
-
jtskY povinné
Súradnica JTSK osi Y
-
distinct string
Max. vzdialenosť od bodu, predvolené
10m -
country string[], obsahujúci
dostupnú krajinuKrajiny v ktorých sa adresa bude vyhľadávať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/places/reverse\Swiftyper\Places::reverse();swiftyper.places.reverse();curl -X POST https://api.swiftyper.sk/v1/places/reverse \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d lat=48.7444321 \
-d lng=22.1794583\Swiftyper\Swiftyper::setApiKey("2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y");
\Swiftyper\Places::reverse(array (
'lat' => 48.7444321,
'lng' => 22.1794583,
));var swiftyper = require("swiftyper")(
"2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y"
);
swiftyper.places.reverse({
"lat": 48.7444321,
"lng": 22.1794583
},
function(err, charges) {
// asynchrónne volanie
}
);[
{
"place_id": "sk_mhUQEtqkZZ3-SseyJ2Y2vw",
"highlight": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_address": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_street": "Kpt.Nálepku 245/13",
"street_number": "245",
"building_number": "13",
"formatted_number": "245/13",
"municipality": "Sobrance",
"postal_code": "07301",
"street": "Kpt.Nálepku",
"region": "Košický kraj",
"county": "Sobrance",
"district": "Sobrance",
"latlng": {
"lat": 48.74443228,
"lon": 22.17945814
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
]Swiftyper\Collection: [
Swiftyper\Address: {
"place_id": "sk_mhUQEtqkZZ3-SseyJ2Y2vw",
"highlight": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_address": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_street": "Kpt.Nálepku 245/13",
"street_number": "245",
"building_number": "13",
"formatted_number": "245/13",
"municipality": "Sobrance",
"postal_code": "07301",
"street": "Kpt.Nálepku",
"region": "Košický kraj",
"county": "Sobrance",
"district": "Sobrance",
"latlng": Swiftyper\SwiftyperObject: {
"lat": 48.74443228,
"lon": 22.17945814
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
][
{
"place_id": "sk_mhUQEtqkZZ3-SseyJ2Y2vw",
"highlight": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_address": "Kpt.Nálepku 245/13, 07301 Sobrance, Slovenská republika",
"formatted_street": "Kpt.Nálepku 245/13",
"street_number": "245",
"building_number": "13",
"formatted_number": "245/13",
"municipality": "Sobrance",
"postal_code": "07301",
"street": "Kpt.Nálepku",
"region": "Košický kraj",
"county": "Sobrance",
"district": "Sobrance",
"latlng": {
"lat": 48.74443228,
"lon": 22.17945814
},
"object": "address",
"formatted_country": "Slovenská republika",
"country": "SK"
}
]Fakturačné adresy
Prostredníctvom služby Swiftyper Business API je možné vyhľadať právnicke osoby a SZČO viacerými spôsobmi - prostredníctvom identifikačného čísla organizácie a na základe názvu právnickej osoby prípadne SZČO.
Popis atribútov
Atribúty
-
business_id string
Unikátny identifikátor subjektu
-
highlight string
Zvýraznená časť zhodná s dopytom vyhľadávania
-
name string
Názov subjektu
-
established_on string
Dátum vzniku
-
terminated_on string
Dátum zániku
-
cin string
Identifikačné číslo organizácie (IČO)
-
tin string
Daňové identifikačné číslo (DIČ)
-
vatin string
Identifikačné číslo pre daň z pridanej hodnoty (IČ DPH)
-
formatted_address string
Naformátovaná adresa
-
street string
Názov ulice
-
formatted_street string
Naformátovaná ulica
-
street_number string
Súpisné číslo
-
building_number string
Orientačné číslo
-
formatted_number string
Naformátované číslo ulice
-
postal_code string
PSČ
-
municipality string
Názov obce
-
legal_form string
Názov právnej formy
-
segment string
Odvetvie
-
organization_size string
Veľkosť organizácie
-
object string
Typ objektu, vždy bude
business -
formatted_country string
Názov krajiny
-
country string
Kód krajiny (dvojmiestny alfabetický kód ISO 3166)
{
"business_id": "sk_yoIWLh0aPlQtxtDy6Mk4Qw",
"highlight": "ESET, spol. s r.o.",
"name": "ESET, spol. s r.o.",
"established_on": "1992-09-17",
"terminated_on": null,
"cin": "31333532",
"tin": "2020317068",
"vatin": "SK2020317068",
"formatted_address": "Einsteinova 24, 85101 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "24",
"street": "Einsteinova",
"formatted_street": "Einsteinova 24",
"postal_code": "85101",
"municipality": "Bratislava",
"legal_form": "Spoločnosť s ručením obmedzeným",
"segment": "Informačné technológie",
"organization_size": "1000-1999 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
Swiftyper\Business: {
"business_id": "sk_yoIWLh0aPlQtxtDy6Mk4Qw",
"highlight": "ESET, spol. s r.o.",
"name": "ESET, spol. s r.o.",
"established_on": "1992-09-17",
"terminated_on": null,
"cin": "31333532",
"tin": "2020317068",
"vatin": "SK2020317068",
"formatted_address": "Einsteinova 24, 85101 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "24",
"street": "Einsteinova",
"formatted_street": "Einsteinova 24",
"postal_code": "85101",
"municipality": "Bratislava",
"legal_form": "Spoločnosť s ručením obmedzeným",
"segment": "Informačné technológie",
"organization_size": "1000-1999 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
{
"business_id": "sk_yoIWLh0aPlQtxtDy6Mk4Qw",
"highlight": "ESET, spol. s r.o.",
"name": "ESET, spol. s r.o.",
"established_on": "1992-09-17",
"terminated_on": null,
"cin": "31333532",
"tin": "2020317068",
"vatin": "SK2020317068",
"formatted_address": "Einsteinova 24, 85101 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "24",
"street": "Einsteinova",
"formatted_street": "Einsteinova 24",
"postal_code": "85101",
"municipality": "Bratislava",
"legal_form": "Spoločnosť s ručením obmedzeným",
"segment": "Informačné technológie",
"organization_size": "1000-1999 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
Vyhľadanie subjektu
Vyhľadanie kontaktných a fakturačných údajov o právnických osobách a SZČO na základe názvu právnickej osoby prípadne SZČO.
Parametre
-
query povinné
Hľadaný výraz
-
country povinné string, obsahujúci
dostupnú krajinuKrajina v ktorej právnicke osoby bude možné vyhľadať
-
active string
Filtrovanie existujúcich (nezaniknutých) subjektov. Predvolene sa zobrazujú všetky subjekty
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/business/query\Swiftyper\Business::query();swiftyper.business.query();curl -X POST https://api.swiftyper.sk/v1/business/query \
-H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9' \
-d query=Alza.cz \
-d country=CZ
\Swiftyper\Swiftyper::setApiKey("v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9");
$re = \Swiftyper\Business::query(array(
"query" => "Alza.cz"
"country" => "CZ"
));var swiftyper = require("swiftyper")(
"v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9"
);
swiftyper.business.query({
query: 'Alza.cz',
country: 'CZ',
}, function(error, results) {
// asynchrónne volanie
});[
{
"business_id": "cz_Rif84y2TQtAubtFdgaUDNA",
"highlight": "<em>Alza.cz</em> a.s.",
"name": "Alza.cz a.s.",
"established_on": "2003-08-26",
"terminated_on": null,
"cin": "27082440",
"tin": null,
"vatin": "CZ27082440",
"formatted_address": "Jankovcova 1522, 17000 Praha, Česká republika",
"street_number": null,
"building_number": "1522",
"street": "Jankovcova",
"formatted_street": "Jankovcova 1522",
"postal_code": "17000",
"municipality": "Praha",
"legal_form": "Akciová společnost",
"segment": "",
"organization_size": "2000 - 2499 zaměstnanců",
"object": "business",
"formatted_country": "Česká republika",
"country": "CZ"
}
]Swiftyper\Collection: [
Swiftyper\Business: {
"business_id": "cz_Rif84y2TQtAubtFdgaUDNA",
"highlight": "<em>Alza.cz</em> a.s.",
"name": "Alza.cz a.s.",
"established_on": "2003-08-26",
"terminated_on": null,
"cin": "27082440",
"tin": null,
"vatin": "CZ27082440",
"formatted_address": "Jankovcova 1522, 17000 Praha, Česká republika",
"street_number": null,
"building_number": "1522",
"street": "Jankovcova",
"formatted_street": "Jankovcova 1522",
"postal_code": "17000",
"municipality": "Praha",
"legal_form": "Akciová společnost",
"segment": "",
"organization_size": "2000 - 2499 zaměstnanců",
"object": "business",
"formatted_country": "Česká republika",
"country": "CZ"
}
][
{
"business_id": "cz_Rif84y2TQtAubtFdgaUDNA",
"highlight": "<em>Alza.cz</em> a.s.",
"name": "Alza.cz a.s.",
"established_on": "2003-08-26",
"terminated_on": null,
"cin": "27082440",
"tin": null,
"vatin": "CZ27082440",
"formatted_address": "Jankovcova 1522, 17000 Praha, Česká republika",
"street_number": null,
"building_number": "1522",
"street": "Jankovcova",
"formatted_street": "Jankovcova 1522",
"postal_code": "17000",
"municipality": "Praha",
"legal_form": "Akciová společnost",
"segment": "",
"organization_size": "2000 - 2499 zaměstnanců",
"object": "business",
"formatted_country": "Česká republika",
"country": "CZ"
}
]Vyhľadanie podľa IČO
Vyhľadanie kontaktných a fakturačných údajov o právnických osobách a SZČO na základe identifikačného čísla organizácie.
Parametre
-
query povinné
Hľadaný výraz
-
country povinné string, obsahujúci
dostupnú krajinuKrajina v ktorej právnicke osoby bude možné vyhľadať
-
active string
Filtrovanie existujúcich (nezaniknutých) subjektov. Predvolene sa zobrazujú všetky subjekty
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/business/identifier\Swiftyper\Business::identifier();swiftyper.business.identifier();curl -X POST https://api.swiftyper.sk/v1/business/identifier \
-H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9' \
-d query=51251761 \
-d country=SK
\Swiftyper\Swiftyper::setApiKey("v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9");
\Swiftyper\Business::identifier(array (
'query' => '51251761',
'country' => 'SK',
));var swiftyper = require("swiftyper")(
"v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9"
);
swiftyper.business.identifier({
query: "51251761",
country: "SK",
},
function(error, results) {
// asynchrónne volanie
}
);[
{
"business_id": "sk_GPAyoJMt_qOd8EJAsqX7og",
"highlight": "Ringier Axel Springer SK, a.s.",
"name": "Ringier Axel Springer SK, a.s.",
"established_on": "2017-12-01",
"terminated_on": null,
"cin": "51251761",
"tin": "2120650609",
"vatin": "SK2120650609",
"formatted_address": "Prievozská 14, 821 09 Bratislava - mestská časť Ružinov, Slovenská republika",
"street_number": null,
"building_number": "14",
"street": "Prievozská",
"formatted_street": "Prievozská 14",
"postal_code": "821 09",
"municipality": "Bratislava - mestská časť Ružinov",
"legal_form": "Akciová spoločnosť",
"segment": "Média, vydavateľstvá a kultúra",
"organization_size": "150-199 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
]Swiftyper\Collection: [
Swiftyper\Business: {
"business_id": "sk_GPAyoJMt_qOd8EJAsqX7og",
"highlight": "Ringier Axel Springer SK, a.s.",
"name": "Ringier Axel Springer SK, a.s.",
"established_on": "2017-12-01",
"terminated_on": null,
"cin": "51251761",
"tin": "2120650609",
"vatin": "SK2120650609",
"formatted_address": "Prievozská 14, 821 09 Bratislava - mestská časť Ružinov, Slovenská republika",
"street_number": null,
"building_number": "14",
"street": "Prievozská",
"formatted_street": "Prievozská 14",
"postal_code": "821 09",
"municipality": "Bratislava - mestská časť Ružinov",
"legal_form": "Akciová spoločnosť",
"segment": "Média, vydavateľstvá a kultúra",
"organization_size": "150-199 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
][
{
"business_id": "sk_GPAyoJMt_qOd8EJAsqX7og",
"highlight": "Ringier Axel Springer SK, a.s.",
"name": "Ringier Axel Springer SK, a.s.",
"established_on": "2017-12-01",
"terminated_on": null,
"cin": "51251761",
"tin": "2120650609",
"vatin": "SK2120650609",
"formatted_address": "Prievozská 14, 821 09 Bratislava - mestská časť Ružinov, Slovenská republika",
"street_number": null,
"building_number": "14",
"street": "Prievozská",
"formatted_street": "Prievozská 14",
"postal_code": "821 09",
"municipality": "Bratislava - mestská časť Ružinov",
"legal_form": "Akciová spoločnosť",
"segment": "Média, vydavateľstvá a kultúra",
"organization_size": "150-199 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}
]Detail subjektu
Načítanie podrobností právnickej osoby a SZČO na základe identifikátora subjektu.
Parametre
-
business_id povinné
Identifikátor subjektu
Výstup
Výstupom je v prípade platného id objekt s popísanými atribútmi, v opačnom pripade sa zobrazí chyba.
POST https://api.swiftyper.sk/v1/business/{business_id}$business = \Swiftyper\Business::detail({business_id});swiftyper.business.detail({business_id})curl -X POST https://api.swiftyper.sk/v1/business/sk_o4kAaWja_nJrxO49lQB4qg \
-H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9'
\Swiftyper\Swiftyper::setApiKey("v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9");
$business = \Swiftyper\Business::detail("sk_o4kAaWja_nJrxO49lQB4qg");var swiftyper = require("swiftyper")(
"v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9"
);
swiftyper.business.detail(
"sk_o4kAaWja_nJrxO49lQB4qg",
function(err, business) {
// asynchrónne volanie
}
);{
"business_id": "sk_seS6EA_SoKNJjCyEyUJf-Q",
"highlight": "Baťa Slovensko, a.s.",
"name": "Baťa Slovensko, a.s.",
"established_on": "1994-06-20",
"terminated_on": null,
"cin": "34103015",
"tin": "2020385675",
"vatin": "SK2020385675",
"formatted_address": "SNP 16, 81106 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "16",
"street": "SNP",
"formatted_street": "SNP 16",
"postal_code": "81106",
"municipality": "Bratislava",
"legal_form": "Akciová spoločnosť",
"segment": "Maloobchod",
"organization_size": "50-99 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}Swiftyper\Business: {
"business_id": "sk_seS6EA_SoKNJjCyEyUJf-Q",
"highlight": "Baťa Slovensko, a.s.",
"name": "Baťa Slovensko, a.s.",
"established_on": "1994-06-20",
"terminated_on": null,
"cin": "34103015",
"tin": "2020385675",
"vatin": "SK2020385675",
"formatted_address": "SNP 16, 81106 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "16",
"street": "SNP",
"formatted_street": "SNP 16",
"postal_code": "81106",
"municipality": "Bratislava",
"legal_form": "Akciová spoločnosť",
"segment": "Maloobchod",
"organization_size": "50-99 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}{
"business_id": "sk_seS6EA_SoKNJjCyEyUJf-Q",
"highlight": "Baťa Slovensko, a.s.",
"name": "Baťa Slovensko, a.s.",
"established_on": "1994-06-20",
"terminated_on": null,
"cin": "34103015",
"tin": "2020385675",
"vatin": "SK2020385675",
"formatted_address": "SNP 16, 81106 Bratislava, Slovenská republika",
"street_number": null,
"building_number": "16",
"street": "SNP",
"formatted_street": "SNP 16",
"postal_code": "81106",
"municipality": "Bratislava",
"legal_form": "Akciová spoločnosť",
"segment": "Maloobchod",
"organization_size": "50-99 zamestnancov",
"object": "business",
"formatted_country": "Slovenská republika",
"country": "SK"
}Preklady
Prostredníctvom služby Swiftyper Internationalization API je možné vyhľadať a preložiť uložené natívne frázy vašej aplikácie.
Popis atribútov fráz
Atribúty
-
id integer
Unikátny identifikátor frázy
-
parent_id integer
Rodičovský identifikátor frázy
-
object string
Typ objektu, vždy bude
phrase -
source array
Objekt zdrojovej frázy
-
hash string
Hash pozostávajúci z textu a popisu
-
text string
Natívna fráza
-
description string
Popis frázy bližšie uvádzajúci jej kontext
-
author string
Meno autora frázy
-
project string
Názov projektu pre ktorý je fráza určená
-
created_at string
Dátum vytvorenia frázy
[
{
"id": 1,
"parent_id": null,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{name} has shared {=a photo} with you."
},
"m": [
{
"token": "name",
"type": 1
}
]
}
},
"hash": "4f8a691d2df612a75c57a793cdd9b0d6",
"text": "{name} has shared {=a photo} with you.",
"description": "Notification about sharing a photo.",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 2,
"parent_id": 1,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
{
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "6f18f947bf712a4ed212027cdeb6a16f",
"text": "{number} photos",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 3,
"parent_id": 2,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
{
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "ee689ff154cd54fa91fefae3a877415a",
"text": "a photo",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
}
]
Swiftyper\Collection: [
Swiftyper\Phrase: {
"id": 1,
"parent_id": null,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{name} has shared Swiftyper\Phrase: {=a photo} with you."
},
"m": [
{
"token": "name",
"type": 1
}
]
}
},
"hash": "4f8a691d2df612a75c57a793cdd9b0d6",
"text": "{name} has shared {=a photo} with you.",
"description": "Notification about sharing a photo.",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 2,
"parent_id": 1,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
Swiftyper\Phrase: {
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "6f18f947bf712a4ed212027cdeb6a16f",
"text": "{number} photos",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 3,
"parent_id": 2,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
{
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "ee689ff154cd54fa91fefae3a877415a",
"text": "a photo",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
}
]
[
{
"id": 1,
"parent_id": null,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{name} has shared {=a photo} with you."
},
"m": [
{
"token": "name",
"type": 1
}
]
}
},
"hash": "4f8a691d2df612a75c57a793cdd9b0d6",
"text": "{name} has shared {=a photo} with you.",
"description": "Notification about sharing a photo.",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 2,
"parent_id": 1,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
{
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "6f18f947bf712a4ed212027cdeb6a16f",
"text": "{number} photos",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
},
{
"id": 3,
"parent_id": 2,
"object": "phrase",
"source": {
"type": "table",
"jsfbt": {
"t": {
"*": "{number} photos",
"_1": "a photo"
},
"m": [
{
"token": "number",
"type": 2,
"singular": true
}
]
}
},
"hash": "ee689ff154cd54fa91fefae3a877415a",
"text": "a photo",
"description": "In the phrase: \"{=Tom} has shared {=a photo} with you.\"",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-04-09 21:33:46"
}
]
Vyhľadanie fráz
Vyhľadanie natívnych fráz. Pokiaľ nepoužijete vyhľadávanie, výstupom budú všetky frázy.
Parametre
-
query
Hľadaný výraz
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/intl/phrases/query\Swiftyper\Business::query();swiftyper.business.query();curl -X POST https://api.swiftyper.sk/v1/intl/phrases/query \
-H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
-d query=Re-type
\Swiftyper\Swiftyper::setApiKey("VÁŠ_API_KĽÚČ");
$re = \Swiftyper\Phrases::query(array(
"query" => "Re-type"
));var swiftyper = require("swiftyper")(
"VÁŠ_API_KĽÚČ"
);
swiftyper.phrases.query({
query: 'Re-type',
}, function(error, results) {
// asynchrónne volanie
});[
{
"id": 6523,
"parent_id": null,
"object": "phrase",
"source": {
"type": "text",
"jsfbt": "Re-type new"
},
"hash": "18bbb08b9f909c7930272edacc121b68",
"text": "Re-type new",
"description": "Label: input for a re-typing of new password",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-05-15 00:04:47"
}
]Swiftyper\Collection: [
Swiftyper\Phrase: {
"id": 6523,
"parent_id": null,
"object": "phrase",
"source": {
"type": "text",
"jsfbt": "Re-type new"
},
"hash": "18bbb08b9f909c7930272edacc121b68",
"text": "Re-type new",
"description": "Label: input for a re-typing of new password",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-05-15 00:04:47"
}
][
{
"id": 6523,
"parent_id": null,
"object": "phrase",
"source": {
"type": "text",
"jsfbt": "Re-type new"
},
"hash": "18bbb08b9f909c7930272edacc121b68",
"text": "Re-type new",
"description": "Label: input for a re-typing of new password",
"author": "richard",
"project": "Super Secret",
"created_at": "2019-05-15 00:04:47"
}
]Uloženie fráz
Uloženie natívnych fráz v anglickom jazyku do databázy aby sa dali preložiť. Ďalšie informácie o prekladoch nájdete v časti Preklady.
Parametre
-
native_strings povinné
Množina objektov kódovaná v JSON formáte.
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je informácia o počte úspešne uložených frázach. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/intl/phrases/upload\Swiftyper\Phrases::upload();swiftyper.phrases.upload();curl -X POST https://api.swiftyper.sk/v1/intl/phrases/upload \
-H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
-d native_strings=[{"hashToText": {"1fd896e07ee91d9f4d6e0f05d0b93bcf": "A simple string"},"desc": "It's simple","project": "website app","author": "M@rty","type": "text","jsfbt": "A simple string"}]
\Swiftyper\Swiftyper::setApiKey("VÁŠ_API_KĽÚČ");
\Swiftyper\Phrases::upload(array (
'native_strings' => '[
{
"hashToText": {
"1fd896e07ee91d9f4d6e0f05d0b93bcf": "A simple string"
},
"desc": "It\'s simple",
"project": "website app",
"author": "M@rty",
"type": "text",
"jsfbt": "A simple string"
}
]',
));var swiftyper = require("swiftyper")(
"VÁŠ_API_KĽÚČ"
);
swiftyper.phrases.upload({
native_strings: '[
{
"hashToText": {
"1fd896e07ee91d9f4d6e0f05d0b93bcf": "A simple string"
},
"desc": "It\'s simple",
"project": "website app",
"author": "M@rty",
"type": "text",
"jsfbt": "A simple string"
}
]',
},
function(error, results) {
// asynchrónne volanie
}
);{
"inserted": 1
}{
"inserted": 1
}{
"inserted": 1
}Popis atribútov prekladov
Atribúty
-
id integer
Unikátny identifikátor prekladu
-
phrase_id integer
Identifikátor zdrojovej frázy
-
object string
Typ objektu, vždy bude
translation -
phrase_hash string
Hash identifikátor zdrojovej frázy
-
hash string
Hash prekladu
-
translation string
Preklad
-
approval_status string
Stav prekladu
-
variations integer[]
Varianty tokenov
-
tokens string[]
Tokeny
-
types integer[]
Druh tokenu (číslo/pohlavie)
-
locale string
Jazyk prekladu
-
created_at string
Dátum preloženia
[
{
"id": 14,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol",
"approval_status": "approved",
"variations": [
1
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:00"
},
{
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchla",
"approval_status": "approved",
"variations": [
2
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:10"
},
{
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol/a",
"approval_status": "auto-approved",
"variations": [
3
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:18"
}
]
Swiftyper\Collection: [
Swiftyper\Translation: {
"id": 14,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol",
"approval_status": "approved",
"variations": [
1
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:00"
},
Swiftyper\Translation: {
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchla",
"approval_status": "approved",
"variations": [
2
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:10"
},
Swiftyper\Translation: {
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol/a",
"approval_status": "auto-approved",
"variations": [
3
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:18"
}
]
[
{
"id": 14,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol",
"approval_status": "approved",
"variations": [
1
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:00"
},
{
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchla",
"approval_status": "approved",
"variations": [
2
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:10"
},
{
"id": 15,
"phrase_id": 5,
"object": "translation",
"phrase_hash": "e8e4d19a2eb0896533722debfca881d9",
"hash": "e8e4d19a2eb0896533722debfca881d9",
"translation": "vás šťuchol/a",
"approval_status": "auto-approved",
"variations": [
3
],
"tokens": [
"__subject__"
],
"types": [
3
],
"locale": "sk_SK",
"created_at": "2019-04-09 22:15:18"
}
]
Vyhľadanie prekladov
Vyhľadanie a načítanie prekladov. Pokiaľ nepoužijete vyhľadávanie, výstupom budú iba preklady ktoré boli schválené automaticky (podľa počtu hlasov), alebo manuálne.
Parametre
-
query
Hľadaný výraz
Výstup
Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/intl/translations/query\Swiftyper\Business::query();swiftyper.business.query();curl -X POST https://api.swiftyper.sk/v1/intl/translations/query \
-H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
-d query=Heslo
\Swiftyper\Swiftyper::setApiKey("VÁŠ_API_KĽÚČ");
$re = \Swiftyper\Translations::query(array(
"query" => "Heslo"
));var swiftyper = require("swiftyper")(
"VÁŠ_API_KĽÚČ"
);
swiftyper.translations.query({
query: 'Heslo',
}, function(error, results) {
// asynchrónne volanie
});[
{
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}
]Swiftyper\Collection: [
Swiftyper\Translation: {
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}
][
{
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}
]Uloženie prekladu
Uloženie prekladu frázy do vybraného jazyka.
Parametre
-
translation povinné
Preklad frázy.
-
hash povinné
Hash prekladanej frázy.
-
locale povinné
Jazyk prekladu.
-
contributor povinné
E-mailová adresa člena organizácie (prekladateľ, správca).
-
api_key povinné
Prístupový API kľúč môžete použiť ako parameter alebo v hlavičke požiadavky
X-Swiftyper-API-Key
Výstup
Výstupom je objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.
POST https://api.swiftyper.sk/v1/intl/translation/submit\Swiftyper\Translations::submit();swiftyper.translations.submit();curl -X POST https://api.swiftyper.sk/v1/intl/translation/submit \
-H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
-d translation=Zopakujte heslo \
-d hash=18bbb08b9f909c7930272edacc121b68 \
-d phash=18bbb08b9f909c7930272edacc121b68 \
-d locale=sk_SK
\Swiftyper\Swiftyper::setApiKey("VÁŠ_API_KĽÚČ");
\Swiftyper\Translations::submit(array (
'translation' => 'Zopakujte heslo',
'hash' => '18bbb08b9f909c7930272edacc121b68',
'phash' => '18bbb08b9f909c7930272edacc121b68',
'locale' => 'sk_SK',
));var swiftyper = require("swiftyper")(
"VÁŠ_API_KĽÚČ"
);
swiftyper.translation.submit({
translation: 'Zopakujte heslo',
hash: '18bbb08b9f909c7930272edacc121b68',
phash: '18bbb08b9f909c7930272edacc121b68',
locale: 'sk_SK',
},
function(error, results) {
// asynchrónne volanie
}
);{
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}Swiftyper\Translation: {
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}{
"id": 7325,
"phrase_id": 6523,
"object": "translation",
"phrase_hash": "18bbb08b9f909c7930272edacc121b68",
"hash": "18bbb08b9f909c7930272edacc121b68",
"translation": "Zopakujte heslo",
"approval_status": "approved",
"variations": [],
"tokens": [],
"types": [],
"locale": "sk_SK",
"created_at": "2019-05-15 22:22:01"
}Poštové adresy
Účelom rozšírenia je rýchle vkladanie adries bez nutnosti vyplňovania všetkých adresných polí formulára na webovej stránke alebo v mobilnej aplikácii.
Vyhľadávacia stratégia
Výsledky vyhľadávania prispôsobujeme podľa zadanej adresy vo formulári. Keď začnete vypĺňaním krajiny alebo obce, zobrazíme adresy týkajúce sa tohto miesta.
Podporované prehliadače
|
|
|
|
|
|
|
|
|
|---|
Inštalácia
Ponúkame viacero spôsobov ako môžete integrovať službu Swiftyper Places WebAPI do Vašej aplikácie.
CDN <script>
JavaScriptová knižnica je dostupná na platforme
jsDelivr CDN.
<script src="https://cdn.jsdelivr.net/npm/swiftyper.js@1.0.6"></script>
Príklad použitia v kóde:
<script src="https://cdn.jsdelivr.net/npm/swiftyper.js@1.0.6"></script>
<div>
<input type="text" id="ulica" placeholder="Ulica, číslo" />
</div>
<div>
<input type="text" id="psc" placeholder="PSČ" />
</div>
<div>
<input type="text" id="mesto" placeholder="Mesto" />
</div>
<div>
<input type="text" id="krajina" placeholder="Krajina" />
<div>
<script>
var placesAutocomplete = new swiftyper.places({
selectors: {
street: document.querySelector('#ulica'),
municipality: document.querySelector('#mesto'),
postalCode: document.querySelector('#psc'),
country: document.querySelector('#krajina'),
},
apiKey: '2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y',
});
</script>
npm
Nájdete nás aj na npm.
Na inštaláciu stačí zadať príkaz:
npm install swiftyper.js --save
Príklad použitia v HTML:
<div>
<input type="text" id="ulica" placeholder="Ulica, číslo" />
</div>
<div>
<input type="text" id="psc" placeholder="PSČ" />
</div>
<div>
<input type="text" id="mesto" placeholder="Mesto" />
</div>
<div>
<input type="text" id="country" placeholder="Krajina" />
<div>
Príklad použitia v JavaScripte:
const { places } = require('swiftyper.js');
const placesAutocomplete = new places({
selectors: {
street: document.querySelector('#ulica'),
municipality: document.querySelector('#mesto'),
postalCode: document.querySelector('#psc'),
country: document.querySelector('#krajina'),
},
apiKey: '2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y',
});
Nastavenia
Popis nastavení ktoré môžete použiť v metóde places({ nastavenia }).
Popis nastavení
-
selectors
vnorené parametre
-
address DOM Element
Element obsahujúci adresu
-
street DOM Element
Element obsahujúci ulicu a číslo
-
streetName DOM Element
Element obsahujúci iba názov ulice
-
streetNumber DOM Element
Element obsahujúci iba číslo ulice
-
municipality DOM Element
Element obsahujúci obec
-
postalCode DOM Element
Element obsahujúci PSČ
-
country DOM Element
Element obsahujúci krajinu
-
-
suggestions string[]
Zoznam polí pre ktoré sa budú zobrazovať návrhy vyhľadávania, hodnoty môžu byť
address,street,streetName,municipalityapostalCode -
endpoint string
Adresa na ktorú je požiadavka smerovaná
-
nextFocus bool, DOM Element
Nastavenie focus na ďalšie pole formulára po výbere adresy
-
apiKey povinné
Prístupový API kľúč
-
highlight bool
Nastavenie zobrazenia zvýraznenia zhodnej časti s dopytom vyhľadávania
-
showNoResults bool
Zobrazenie upozornenia v prípade nenájdených výsledkov
-
events string[]
Typy udalostí na ktoré bude reagovať vyhľadávanie
-
country string[], obsahujúci
dostupné krajinyKrajiny ktorých adresy bude možné vyhľadať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
minlength integer
Minimálna dĺžka výrazu na začatie vyhľadávania
-
debounce integer
Minimálna pauza pred začatím vyhľadávania cez API, počas zadávania výrazu sa časovač vynuluje. Predvolená hodnota je
250(ms) -
theme string
Téma rozšírenia, môže byť
modern-light(predvolené),modern-darkaleboclassic -
htmlAutocomplete bool
Nastavenie HTML atribútu
autocomplete, predvolene pole nastavujeme naautocomplete=off -
context string[]
Nastavenie oblastí pre vyhľadávanie (kľúč
place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec -
contextType string
Nastavenie typu vyhľadávacieho kontextu. Použite
strictak chcete vyhľadávať adresu s ďalšími zadanými poliami (napr. mesto, psč) alebopreferencepokiaľ chete adresy zo zadaného miesta uprednostniť -
aroundLatLng string
Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte
latitude,longitudenapr.49.1992988,18.8211994 -
aroundLatLngViaIP string
Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa, predvolená hodnota je
true -
itemTemplate function
Funkcia na naformátovanie položky vyhľadávania
const { places } = require('swiftyper.js');
const placesAutocomplete = new places({
selectors: {
street: document.querySelector('#ulica'),
streetNumber: document.querySelector('#cisloUlice'),
municipality: document.querySelector('#mesto'),
postalCode: document.querySelector('#psc'),
country: document.querySelector('#country'),
},
country: ['CZ', 'SK'],
apiKey: '2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y',
});
Udalosti
Rozšírenie používa určité udalosti, ktoré si môžete prispôsobiť.
Popis udalostí
-
change
Zavolá sa, keď sa zvolí adresa zo zoznamu vyhľadaných adries.
-
suggestions
Zavolá sa, keď sa načíta zoznam vyhľadaných adries.
Táto udalosť sa zavolá aj v prípade, že sa nenájdu žiadne výsledky. -
limit
Zavolá sa, keď bude presiahnutý mesačný limit.
-
error
Zavolá sa, keď sa vyskytne problém s vyhľadaním adresy alebo ak bude presiahnutý mesačný limit.
const { places } = require('swiftyper.js');
const placesAutocomplete = new places({
apiKey: '2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y',
});
placesAutocomplete.on('change', e => console.log(e.suggestion));
placesAutocomplete.on('suggestions', e => console.dir(e.suggestions));
placesAutocomplete.on('limit', e => console.error(e.error));
placesAutocomplete.on('error', e => console.error(e.error));
Metódy
Popis metód ktoré môžete použiť po inicializácii metódy places().
Popis metód
-
configure
Zmena nastavení rozšírenia.
-
on
Nastavenie udalostí.
-
destroy
Zrušenie funkcií rozšírenia.
Štýlovanie
Rozšírenie používa pár základných CSS tried a tágov ktoré si môžete pre vašu aplikáciu prispôsobiť.
CSS triedy a tágy
-
swiftyper_wrapper
.swiftyper_wrapper je rodičovskou triedou vyhľadávacieho poľa
-
swiftyper_list
Trieda .swiftyper_list obsahuje zoznam návrhov vyhľadávania
-
swiftyper_result
Trieda .swiftyper_result obsahuje každý jeden návrh vyhľadávania
-
<em>
Tág <em> v zozname výsledkov sa používa na zvýraznenie zhodných častí s dopytom vyhľadávania
Príklady použitia
Poštovú adresu je možné zadať niekoľkými spôsobmi, v týchto príkladoch použitia uvádzame tie najpoužívanejšie.
Formulár hľadajúci iba slovenské adresy
Formulár s možnosťou výberu krajiny
Formulár s oddelenou ulicou a číslom
Formulár s adresou v jednom poli
Vyhľadávanie adries iba z konkrétnej obce
-
Výsledky vyhľadávania sú obmedzené na mesto Žilina. Skúste vyhľadať napríklad ulice: Národná, Lichardova alebo Jedlíková.
<div>
<input type="text" class="ulica" placeholder="Ulica, číslo"/>
</div>
<div>
<input type="text" class="psc" placeholder="PSČ"/>
</div>
<div>
<input type="text" class="mesto" placeholder="Mesto"/>
</div>
<div>
<input type="text" class="krajina" placeholder="Krajina"/>
</div>
new swiftyper.places({
selectors: {
street: ".ulica",
municipality: ".mesto",
postalCode: ".psc",
country: ".krajina",
},
country: ['SK'],
apiKey: '2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y',
});Fakturačné adresy
Účelom rozšírenia je rýchle vkladanie fakturačných údajov bez nutnosti vyplňovania všetkých adresných polí formulára na webovej stránke alebo v mobilnej aplikácii.
Podporované prehliadače
|
|
|
|
|
|
|
|
|
|
|---|
Inštalácia
Ponúkame viacero spôsobov ako môžete integrovať službu Swiftyper Business WebAPI do Vašej aplikácie.
CDN <script>
JavaScriptová knižnica je dostupná na platforme
jsDelivr CDN.
<script src="https://cdn.jsdelivr.net/npm/swiftyper.js@1.0.6"></script>
Príklad použitia v kóde:
<script src="https://cdn.jsdelivr.net/npm/swiftyper.js@1.0.6"></script>
<div>
<input type="text" id="subjekt" placeholder="Názov organizácie" />
</div>
<div>
<input type="text" id="ico" placeholder="IČO" />
</div>
<div>
<input type="text" id="ic_dph" placeholder="IČ DPH" />
</div>
<div>
<input type="text" id="dic" placeholder="DIČ" />
</div>
<div>
<input type="text" id="ulica" placeholder="Ulica, číslo" />
</div>
<div>
<input type="text" id="psc" placeholder="PSČ" />
</div>
<div>
<input type="text" id="mesto" placeholder="Mesto" />
</div>
<div>
<input type="text" id="krajina" placeholder="Krajina" />
</div>
<script>
var businessAutocomplete = new swiftyper.business({
selectors: {
name: document.querySelector('#subjekt'),
cin: document.querySelector('#ico'),
tin: document.querySelector('#dic'),
vatin: document.querySelector('#ic_dph'),
street: document.querySelector('#ulica'),
municipality: document.querySelector('#mesto'),
postalCode: document.querySelector('#psc'),
country: document.querySelector('#krajina'),
},
apiKey: 'v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9',
});
</script>
npm
Nájdete nás aj na npm.
Na inštaláciu stačí zadať príkaz:
npm install swiftyper.js --save
Príklad použitia v HTML:
<div>
<input type="text" id="subjekt" placeholder="Názov organizácie" />
</div>
<div>
<input type="text" id="ico" placeholder="IČO" />
</div>
<div>
<input type="text" id="ic_dph" placeholder="IČ DPH" />
</div>
<div>
<input type="text" id="dic" placeholder="DIČ" />
</div>
<div>
<input type="text" id="ulica" placeholder="Ulica, číslo" />
</div>
<div>
<input type="text" id="psc" placeholder="PSČ" />
</div>
<div>
<input type="text" id="mesto" placeholder="Mesto" />
</div>
<div>
<input type="text" id="krajina" placeholder="Krajina" />
<div>
Príklad použitia v JavaScripte:
const { business } = require('swiftyper.js');
const businessAutocomplete = new business({
selectors: {
name: "#subjekt",
cin: "#ico",
tin: "#dic",
vatin: "#ic_dph",
street: "#ulica",
municipality: "#mesto",
postalCode: "#psc",
country: "#krajina",
},
apiKey: 'v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9',
});
Nastavenia
Popis nastavení ktoré môžete použiť v metóde business({ nastavenia }).
Popis nastavení
-
selectors
vnorené parametre
-
name DOM Element
Element obsahujúci názov subjektu
-
cin DOM Element
Element obsahujúci IČO
-
tin DOM Element
Element obsahujúci DIČ
-
vatin DOM Element
Element obsahujúci IČ DPH
-
address DOM Element
Element obsahujúci adresu
-
street DOM Element
Element obsahujúci ulicu a číslo
-
streetName DOM Element
Element obsahujúci iba názov ulice
-
streetNumber DOM Element
Element obsahujúci iba číslo ulice
-
municipality DOM Element
Element obsahujúci obec
-
postalCode DOM Element
Element obsahujúci PSČ
-
country DOM Element
Element obsahujúci krajinu
-
-
suggestions string[]
Zoznam polí pre ktoré sa budú zobrazovať návrhy vyhľadávania, hodnoty môžu byť
nameacin -
endpoint string
Adresa na ktorú je požiadavka smerovaná
-
active string
Filtrovanie existujúcich (nezaniknutých) subjektov. Predvolene sa zobrazujú všetky subjekty
-
nextFocus bool, DOM Element
Nastavenie focus na ďalšie pole formulára po výbere subjektu
-
apiKey povinné
Prístupový API kľúč
-
highlight bool
Nastavenie zobrazenia zvýraznenia zhodnej časti s dopytom vyhľadávania
-
showNoResults bool
Zobrazenie upozornenia v prípade nenájdených výsledkov
-
events string[]
Typy udalostí na ktoré bude reagovať vyhľadávanie
-
country povinné string, obsahujúci
dostupnú krajinuKrajina v ktorej právnicke osoby bude možné vyhľadať
-
limit integer
Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov
-
minlength integer
Minimálna dĺžka výrazu na začatie vyhľadávania
-
debounce integer
Minimálna pauza pred začatím vyhľadávania cez API, počas zadávania výrazu sa časovač vynuluje. Predvolená hodnota je
250(ms) -
theme string
Téma rozšírenia, môže byť
modern-light(predvolené),modern-darkaleboclassic -
htmlAutocomplete bool
Nastavenie HTML atribútu
autocomplete, predvolene pole nastavujeme naautocomplete=off -
itemTemplate function
Funkcia na naformátovanie položky vyhľadávania
const { business } = require('swiftyper.js');
const businessAutocomplete = new business({
selectors: {
name: document.querySelector('#subjekt'),
cin: document.querySelector('#ico'),
tin: document.querySelector('#dic'),
vatin: document.querySelector('#ic_dph'),
street: document.querySelector('#ulica'),
streetNumber: document.querySelector('#cisloUlice'),
municipality: document.querySelector('#mesto'),
postalCode: document.querySelector('#psc'),
country: document.querySelector('#krajina'),
},
country: 'SK',
apiKey: 'v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9',
});
Udalosti
Rozšírenie používa určité udalosti, ktoré si môžete prispôsobiť.
Popis udalostí
-
change
Zavolá sa, keď sa zvolí adresa zo zoznamu vyhľadaných adries.
-
suggestions
Zavolá sa, keď sa načíta zoznam vyhľadaných adries.
Táto udalosť sa zavolá aj v prípade, že sa nenájdu žiadne výsledky. -
limit
Zavolá sa, keď bude presiahnutý mesačný limit.
-
error
Zavolá sa, keď sa vyskytne problém s vyhľadaním adresy alebo ak bude presiahnutý mesačný limit.
const { business } = require('swiftyper.js');
const businessAutocomplete = new business({
apiKey: 'v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9',
});
businessAutocomplete.on('change', e => console.log(e.suggestion));
businessAutocomplete.on('suggestions', e => console.dir(e.suggestions));
businessAutocomplete.on('limit', e => console.error(e.error));
businessAutocomplete.on('error', e => console.error(e.error));
Metódy
Popis metód ktoré môžete použiť po inicializácii metódy business().
Popis metód
-
configure
Zmena nastavení rozšírenia.
-
on
Nastavenie udalostí.
-
destroy
Zrušenie funkcií rozšírenia.
Štýlovanie
Rozšírenie používa pár základných CSS tried a tágov ktoré si môžete pre vašu aplikáciu prispôsobiť.
CSS triedy a tágy
-
swiftyper_wrapper
.swiftyper_wrapper je rodičovskou triedou vyhľadávacieho poľa
-
swiftyper_list
Trieda .swiftyper_list obsahuje zoznam návrhov vyhľadávania
-
swiftyper_result
Trieda .swiftyper_result obsahuje každý jeden návrh vyhľadávania
-
<em>
Tág <em> v zozname výsledkov sa používa na zvýraznenie zhodných častí s dopytom vyhľadávania
Príklady použitia
Formulár hľadajúci podľa názvu a IČO
-
Formulár hľadajúci iba podľa názvu
-
<div> <input type="text" id="subjekt" placeholder="Názov organizácie" /> </div> <div> <input type="text" id="ico" placeholder="IČO" /> </div> <div> <input type="text" id="ic_dph" placeholder="IČ DPH" /> </div> <div> <input type="text" id="dic" placeholder="DIČ" /> </div> <div> <input type="text" id="ulica" placeholder="Ulica, číslo" /> </div> <div> <input type="text" id="psc" placeholder="PSČ" /> </div> <div> <input type="text" id="mesto" placeholder="Mesto" /> </div> <div> <input type="text" id="krajina" placeholder="Krajina" /> <div>new swiftyper.business({ selectors: { name: '#subjekt', cin: '#ico', tin: '#dic', vatin: '#ic_dph', street: '#ulica', municipality: '#mesto', postalCode: '#psc', country: '#krajina', }, suggestions: ['name', 'cin'], nextFocus: false, apiKey: 'v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9', });
-