API dokumentacija

Užklausos nuoroda

GETPOST
https://api.postapi.lt/api.php

Užklausos parametrai

Parametras Tipas Aprašymas
key string API prieigos raktas. Privalomas
Paieškos parametrai Neprivalomi*
city string Miesto pavadinimas arba pavadinimo pradžia.
address string Gatvės pavadinimas arba pavadinimo pradžia ir namo numeris (pvz.: Birutės g. 8, Birutės 8).
street string

Gatvės pavadinimas arba pavadinimo pradžia.

Šis parametras yra ignoruojamas jei yra naudojamas parametras address.

house_number string

Namo numeris.

Šis parametras yra ignoruojamas jei yra naudojamas parametras address.

postcode string Pašto kodas.
municipality string Savivaldybės pavadinimas arba pavadinimo pradžia.
post_office string Pašto skyriaus pavadinimas arba pavadinimo pradžia.
Paieškos nustatymų parametrai Neprivalomi
limit integer / string

Gražinamų įrašų skaičius. Galimos reikšmės nuo 1 iki 20.

Jei parametras nenurodytas - grąžinama 10 įrašų.

page integer / string

Pateikiamų rezultatų puslapio numeris. Galimos reikšmės nuo 1 iki maksimalaus puslapių skaičiaus, kuris nurodomas API gražinamame atsakyme.

Jei parametras nenurodytas - grąžinamas 1 puslapis.

group string

Rezultatų grupavimo pagal pasirinkta laukelį.

Galimi laukeliai: city, street, municipality.

Jei parametras nenurodytas - rezultatai negrupuojami.

order string

Rezultatų rikiavimo parametras.

Galimi laukeliai: city, street, house_number, municipality, postcode, post_office.

Rikiavimas didėjimo tvarka: asc;

Rikiavimas mažėjimo tvarka: desc;

Taip pat galimas rikiavimas pagal kelis laukelius (iki 3 laukelių).

Pavyzdys: order=city-asc
order=city-asc.street-desc

Jei parametras nenurodytas - naudojamas automatinis rezultatų rikiavimas.

Žymėjimas

Privalomas – laukelis yra privalomas.
Neprivalomi* – laukeliai yra neprivalomi, jei bent vienas paieškos parametras yra jau nurodytas. Parametrą house_number galima naudoti tik su kitu paieškos parametru.
Neprivalomi – laukeliai yra neprivalomi.

API Demo


 
                                    {"success":true,"rows_returned":1,"total_found":1,"data":[{"postcode_full":"LT-91203","postcode":"91203","street":"Birut\u0117s g.","house_number":"8","address":"Birut\u0117s g. 8","city":"Klaip\u0117da","municipality":"Klaip\u0117dos m. sav.","post_office":"Klaip\u0117dos centrinis pa\u0161tas"}],"page":{"current":1,"total":1,"per_page":10}}
                                

Užklausos rezultatai

Užklausos rezultatai yra grąžinami application/json formatu.

Rezultatų parametrai

Parametras Tipas Aprašymas
success bool

Užklausos rezultato parametras. Galimos reikšmės: true arba false.

Jei užklausa buvo įvykdyta sėkmingai grąžinamas rezultatas true, net jei ir buvo nerasta kriterijus atitinkančių įrašų.

Rezultatas false grąžinamas dėl tokių priežąsčių kaip neužpildyti privalomi laukeliai, blogas arba negaliojantis API raktas, viršytas užklausų limitas ar įvykus sisteminei klaidai.

rows_returned integer

Grąžintų įrašų skaičius.

Jei success parametro reikšmė yra false - šis parametras užklausos rezultate neišvedamas.

total_found integer

Iš viso surastų įrašų skaičius.

Jei success parametro reikšmė yra false - šis parametras užklausos rezultate neišvedamas.

data array

Parametras, kuriame išvedami surasti įrašai pagal užklausos paieškos parametrus.

Jei success parametro reikšmė yra false - šis parametras grąžinamas tuščias.

Įrašo parametrai
postcode_full string Pašto kodas su priešdėliu LT-XXXXX (pilnas formatas).
postcode string Pašto kodas XXXXX(trumpas formatas).
street string

Gatvės pavadinimas.

house_number string

Namo numeris.

address string Adresas – gatvės pavadinimas ir namo numeris.
city string Miesto pavadinimas.
municipality string Savivaldybės pavadinimas.
post_office string Pašto skyriaus pavadinimas.
Puslapiavimo parametrai
page array

Masyvas, kuriame pateikiami puslapiavimo parametrai.

Jei success parametro reikšmė yra false - šis parametras užklausos rezultate neišvedamas.

current integer Parametras, kuris nurodo pateiktą paieškos rezultato įrašų puslapį.
total integer Parametras, kuris nurodo kiek yra paieškos rezultato įrašų puslapių.
per_page integer Parametras, kuris nurodo kiek įrašų pateikiama viename puslapyje.

Klaidų pranešimai

Klaidos pranešimas yra grąžinamas application/json formatu.

Pavyzdinis klaidos pranešimas

Klaidos pranešimo parametrai

Parametras Tipas Aprašymas
success bool

Užklausos rezultato parametras. Klaidos atveju parametro reikšmė visuomet false.

message string

Klaidos pranešimas.

error_code integer

Klaidos kodas.

data array Parametras, kuriame išvedami surasti įrašai pagal užklausos paieškos parametrus. Klaidos atveju parametro reikšme yra tuščia.

Galimi klaidų pranešimai

Kodas Klaidos tekstas
1001 Užklausos vykdymui reikia nurodyti bent vieną iš paieškos parametrų!
1002 Viršytas dienos užklausų limitas!
1003 Nurodytas raktas yra blogas arba negaliojantis!
1004 Privaloma nurodyti API raktą!
1005 Nenustatyta klaida! Prašome susisiekti su sistemos administratoriais.

Reikalavimai

Naudojant nemokamą API raktą yra privaloma svetainėje ar aplikacijoje patalpinti nuorodą į mūsų svetainę: "Pašto kodų integracija - PostAPI.lt"

HTML kodas <small>Pašto kodų integracija - <a href="http://postapi.lt" target="_blank">PostAPI.lt</a></small>