API Info
Autentifikacija
Vilnius Events API palaiko HTTP Basic Authentication metodą siunčiant užklausas. API užklausos be galiojančio vartotojo vardo ir slaptažodžio bus atmestos ir užklausa grąžins 403 klaidą.
Užklausa
URL: https://www.vilnius-events.lt/api/
Metodas: GET
Rezultatas: sąrašas renginių atitinkančių užklausos parametrus JSON formatu
Parametrai
Siunčiant užklausą galima nurodyti papildomus parametrus (pvz.: https://www.vilnius-events.lt/api/?lang=en&…). Užklausos parametrai nėra privalomi ir jų nepateikus naudojamos žemiau nurodytos reikšmės pagal nutylėjimą.
| Parametras | Galimos reikšmės/parametro tipas | Aprašymas |
| id | number | Grąžina vieno renginio infromaciją su papildomais laukais (price, tickets, location_working_time). N.B! nurodžius „id” parametrą, užklausa ignoruos parametrus „date_from”, „date_to”, „category”, „limit” ir grąžins tik vieną įrašą. Pagal nutylėjimą: false |
| lang | en, lt | Grąžina renginių aprašymus pasirinkta kalba. Pagal nutylėjimą: lt |
| date_from | date: „Y-m-d” Pvz. 2021-11-30 |
Grąžina renginius, kurie prasideda nuo nurodytos datos (imtinai) ar dar vyksta nurodytą dieną. Jeigu nurodoma praėjusio laikotarpio data – naudojama reikšmė pagal nutylėjimą. Pagal nutylėjimą: šiandiena |
| date_to | date: „Y-m-d” Pvz. 2022-01-09 |
Grąžina renginius, kurie prasideda ar vyksta iki nurodytos datos (imtinai). Pagal nutylėjimą: šiandiena + 2 dienos |
| category | festivaliai, koncertai, nemokami-renginiai, spektakliai, parodos, online, po-atviru-dangumi, sporto-renginiai, ekskursijos, kiti, uncategorized | Grąžina renginius, kurie turi priskirtą kategoriją. Jeigu nurodytos kelios kategorijos (atskirtos kableliu) – grąžinama, jeigu atitinka nors vieną iš kategorijų. Pagal nutylėjimą: visos kategorijos |
| limit | number | Maksimalus grąžinamų renginių skaičius. Jeigu skaičius viršija reikšmę nurodytą pagal nutylėjimą – naudojama reikšmė pagal nutylėjimą. Pagal nutylėjimą: 50 |
Užklausos atsakymas
Užklausos atsakymas grąžinamas JSON fromatu. Visos reikšmės gali būti tuščios išskyrus „id”.
[{
"id":, //unikalus objekto id
"link":, //nuoroda į Vilnius Events renginio puslapį
"date": , //renginio data ("2021-04-15 20:00", "2021-04-15 - 2021-05-20", "Pirmadieniais" ir kt.)
"title": , //renginio pavadinimas
"content": , //renginio aprašymas (html)
"image_src":, //nuoroda į renginio paveikslėlį
"event_url": , //nuoroda į organizatoriu renginio puslapį
"event_email":, //organizatorių el. paštas
"location_name":, //renginio vietos pavadinimas
"location_info":, //papildoma informacija apie renginio vietą (html)
"category":, //kategorijų sąrašas priskirtų renginiui
"location_address":, //renginio vietos adresas
"location_url":, //nuoroda į renginio svetainę
"event_on_weekdays":, //informacija apie renginio savaitės dieną ir laiką (jeigu vyksta kelintadieniais)
"price":, //informacija apie kainas - apima adults/students/free/info (html)
"price_for_adults":, //bilietų kaina suagusiam (html)
"price_for_students":, //bilietų kaina studentams (html)
"free_admission":, //nemokamas įėjimas (boolean)
"price_additional_info":, //papildoma informacija apie kainas (html)
"location_working_time:, //renginio vietos darbo laikas (html)
"tickets":, //informacija apie bilietų isigijimą (html)
}]
* – mėlynai pažymėti parametrai grąžinami tik užklausose dėl konkretaus renginio (nurodant „id” parametrą)
Klaidos
Pateikus neteisingus užklausos parametrus arba neradus atitinkančių renginių pagal nurodytus parameturs – užklausa grąžins „null” reikšmę.
