Visi Caropen skaičiai prieinami per viešą, tik skaitymui skirtą API. Registracija ir raktai nereikalingi, atsakymai – JSON. Tuos pačius prieigos taškus naudoja ir ši svetainė. Žemiau – prieigos taškų sąrašas, sugeneruotas iš OpenAPI specifikacijos.
Pagrindai
- Bazinis adresas:
https://api.caropen.lt; visi keliai prasideda/api/public/. - Formatas: tik
application/json. SiųskiteAccept: application/jsonarbaAcceptantraštės nenurodykite. - Autentifikacija: nereikalinga. API pateikia tik apibendrintus skaičius – jokių duomenų apie konkretų automobilį ar stotį.
Šaltinio nurodymas
Pirminiai duomenys skelbiami pagal CC BY 4.0 licenciją. Kur rodote API skaičius, privalote nurodyti šaltinį: tekstą iš GET /api/public/meta lauko licence.attribution (Valstybės duomenų agentūra / Transeksta, Transporto priemonių techninės apžiūros duomenys, data.gov.lt) su licencija ir Caropen.lt su nuoroda. Daugiau – Duomenys ir licencija.
Naudojimo apribojimai
- Atsakymai savaitę saugomi Cloudflare talpykloje ir atnaujinami po kiekvieno savaitinio paskelbimo, todėl tų pačių adresų dažniau nei kartą per dieną užklausti nėra prasmės.
- Kol kas griežti apribojimai netaikomi, tačiau prašome ne daugiau kaip 60 užklausų per minutę iš vieno IP adreso. Ateityje šis apribojimas bus taikomas naudojantiems API be rakto (atsakymas
429suRetry-After). - Reikia daugiau ar masinių duomenų (pvz. visų modelio × metų grupių)? Parašykite info@caropen.lt – planuojami API raktai su didesniais limitais.
- Neperparduokite API kaip savo paslaugos nenurodę šaltinio ir neapkraukite jos nuskaitydami kiekvieno puslapio – visų publikuotų puslapių sąrašą pateikia svetainės žemėlapio rinkiniai (
/sitemap/{set}).
Talpinimas ir sąlyginės užklausos
Kiekvienas sėkmingas atsakymas turi Cache-Control: max-age=0, public, s-maxage=604800, stale-while-revalidate=86400, ETag ir Last-Modified. Jie pasikeičia tik paskelbus naujus skaičius, todėl su If-None-Match arba If-Modified-Since gausite tuščią 304 Not Modified, kol niekas nepasikeitė. Duomenų šviežumą rodo GET /api/public/meta laukas freshness.lastPublish.
Duomenų formatas
- Dalys – skaičiai nuo 0 iki 1 (
passRate,rollbackShare,fuelMixreikšmės).ciLoirciHi– 95 % Wilsono pasikliautinojo intervalo apatinė ir viršutinė reikšmės. n– pagrindinių apžiūrų skaičius (pakartotinės apžiūros neįskaitomos).nullvietoje trūkstamų reikšmių – laukas visada pateikiamas, o trūkstamas skaičius yranull.- Kodai (degalų, verdiktų) neverčiami:
PETROL,DIESEL,NO_DEFECTS,MAJOR_DEFECTSir t. t. - Slug (trumpieji identifikatoriai) –
[a-z0-9-], vienodi visomis kalbomis. - Publikavimo slenksčiai –
GET /api/public/metalaukethresholds. Slenksčio nepasiekusiai grupei grąžinamapublishable: false, o turinčiai mažiau nei 30 pagrindinių apžiūrų –404. Plačiau – metodika.
Klaidos
Apie klaidas pranešama application/problem+json formatu su laukais title, detail ir status:
| Kodas | Kada grąžinamas |
|---|---|
400 | Netinkamas page parametras (/sitemap/{set}?page=x). |
404 | Nežinomas slug, metai ar laikotarpis; grupėje mažiau nei 30 apžiūrų; tuščias reitingo pjūvis. |
406 | Accept antraštėje nurodytas ne application/json formatas. |
422 | Netinkami užklausos parametrai; atsakyme papildomai violations[]. |