Apie projektą
api.gov.lt – tai valstybės informacinių sistemų API katalogas. Katalogas yra skirtas valstybės informacines sistemas vystančioms institucijoms ir įmonėms padėti surasti reikalingus duomenis. Kataloge pateikiama API sąsajų dokumentacija bei kontaktai, kuriais galima kreiptis į sistemų tvarkytojus norint gauti prieigą prie testinės aplinkos arba pasirašyti duomenų gavimo sutartį. Kataloge nėra talpinami konkretūs API adresai, slaptažodžiai ar raktai – visa pateikiama informacija yra vieša.
Šiuo metu talpinamos tik OpenAPI (REST/JSON) API sąsajos. Esant poreikiui svarstysime galimybę pateikti WSDL sąsajų dokumentaciją, perkeliant ją iš VIISP sąsajų sąrašo.
Šis katalogas yra vystomas kaip atviro kodo projektas. Visas kodas yra patalpintas https://github.com/ivpk/public-api-catalog. Institucijos, įmonės bei pavieniai asmenys gali siūlyti patobulinimus, kuriuos katalogo valdytojai peržiūrės ir patvirtins.
Katalogas paremtas „Docusaurus“ atviro kodo karkasu ir patalpintas GitHub Pages platformoje. Katalogą administruoja Informacinės visuomenės plėtros komitetas. Kilus klausimams, kreipkitės į marijonas.petrauskas@ivpk.lt arba karolis.vycius@lrv.lt.
Kaip pridėti naują API sąsają?
Jei norite pridėti naują API sąsają, papildykite failą https://github.com/ivpk/public-api-catalog/blob/main/specifications.json ir sukurkite prašymą įtraukti pakeitimą (GitHub „pull request“ funkcija). Specifikacijų faile reikia nurodyti URL adresą, iš kur bus automatiškai parsiunčiama OpenAPI specifikacija. Rekomenduojame OpenAPI specifikaciją pateikti bendroje informacinės sistemos infrastruktūroje – pavyzdžiui, jeigu sistemos viešas adresas yra https://spis.lt/, specifikacijos adresas galėtų būti https://spis.lt/api.json:
...
"specifications": [
{
"id": "spis",
"label": "Socialinės paramos šeimai IS",
"url": "https://spis.lt/api.json"
}
]
...
Vystymo kryptys
- WSDL sąsajų palaikymas
- API kūrimo rekomendacijos, gairės
- Integracija su registrai.lt