Dokumentácia - API


Registrácia, cena a limity

Údaje poskytujeme bezplatne, no pre použitie je potrebné získať API kľúč registráciou na https://is.tatry.sk

Limit je 1000 volaní API počas aktuálneho dňa cez jeden API kľúč.

API kľúč môžete posielať formou GET parametra apikey

GET https://www.tatry.sk/api/events/?apikey=VAS_API_KLUC

alebo formou HTTP hlavičky s kľúčom apikey

curl -H "apikey:VAS_API_KLUC" https://www.tatry.sk/api/events/

Princíp fungovania

Zoznam podujatí uverejnený na www.tatry.sk/podujatia/ je možné získať vo formáte JSON prostredníctvom HTTP GET požiadavky

Povolený je protokol HTTP aj HTTPS, v prípade, že API kľúč posielate formou GET parametra, odporúčame používať HTTPS.


Základné volanie

Základná možnosť - získanie podujatí v najbližšom mesiaci

GET https://www.tatry.sk/api/events/?apikey=VAS_API_KLUC

Príklad JSON odpovede

{
    "filtered": 100,
    "total": 547, 
    "limit": 100, 
    "offset": 0, 
    "api_limit": 1000,
    "api_usage": 79,
    "data": [
        .....
        {
            "id": 30723,
            "title": "Čaro detstva",
            "from": "2019-01-18 09:00:00",
            "to": "2019-09-30 17:00:00",
            "content": "<p>Srdečne Vás pozývame...",
            "poster": "http://www.tatry.sk/wp-content/uploads/2019/01/Čaro-detstv.jpg",
            "poster_thumbnail": "http://www.tatry.sk/wp-content/uploads/2019/01/Čaro-detstv-223x120.jpg",
            "place": "Podtatranské múzeum v Poprade",
            "web": "http://www.muzeumpp.sk/expozicie/",
            "url": "http://www.tatry.sk/caro-detstva/",
            "category": {
                "kultura":"Kultúra",
                ...
            },
            "locality": {
                "okolie":"Poprad a okolie"
            }
        },
        ....
    }

Rozšírené volanie s filtrom

API umožňuje vyfiltrovať pridaním ďalších parametrov

GET https://www.tatry.sk/api/events/?apikey=VAS_API_KLUC&parameter1=hodnota1&parameter2=hodnota2

Parametre

category:"kultura", // filter na kategóriu (vid nizsie)
locality:"smokovce", // filter na oblast (vid nizsie)
limit:"5", // počet zobrazených podujatí (max. 100)
offset:"0", // zobrazenie podujatia od X záznamu (predvolené 0 = prvý záznam)
datefrom:"", //datum od v tvare 1.1.2019 dd.mm.YYYY alebo 2019-01-01 YYYY-mm-dd, predvolené = dnes
dateto:"",  // datum do v tvare dd.mm.YYYY alebo 2019-01-01 YYYY-mm-dd, predvolené = datefrom + mesiac

Príklad pre kategóriu ŠPORT v lokalite POPRAD vo februári 2019

GET https://www.tatry.sk/api/events/?apikey=VAS_API_KLUC&datefrom=2019-02-01&dateto=2019-02-28&locality=poprad&category=sport

Kategórie

Kompletný číselník kategórií získate na

GET https://www.tatry.sk/api/categories/?apikey=VAS_API_KLUC

Číselník kategórii [category=*] Viac možností naraz oddeľte čiarkou - sport,kultura

silvester - Silvester
tatransky-ladovy-dom - Tatranský ľadový dóm
kultura - Kultúra
sport - Šport
gastronomia - Gastronómia
zabava - Zábava
pre-rodiny - Pre rodiny
dlhodobe-expozicie - Dlhodobé expozície
tatranske-kulturne-leto - Tatranské kultúrne leto
vianoce - Vianoce

Číselník lokalít [locality=*] Viac možností naraz oddeľte čiarkou - poprad,smokovce

poprad - Poprad
smokovce - Smokovce a okolie
strbske-pleso - Štrbské Pleso a okolie
podtatranske-obce - Podtatranské obce
okolie - Okolie
tatranska-lomnica - Tatranská Lomnica a okolie