Pasta poligonu serviss

Jāņa sētas nodrošinātais pasta poligonu tīmekļa serviss (API) nodrošina Latvijas, Igaunijas un lielākās daļas Lietuvas pasta poligonu robežu koordinātu informācijas pieejamību Klienta ārējam IT sistēmām. Pasta poligonu API rezultātu meklēšana notiek veicot HTTP GET pieprasījumu uz klientam piešķirtu URL saiti, kas ir pieejams kā REST veida tīmekļa serviss. Klients var padodot API teksta vaicājumu ar pasta poligona indeksa vērtību (vai vairākām; kā arī pasta indeksu grupas) un kā atbildes rezultātu saņemot konkrēto poligonu virsotņu koordinātas.

Servisa URL

Servisa saitei jāatbilst šādai formai: https://api.kartes.lv/v3/<klienta_atslega>/postal_codes?

Atgriezto datu formāts ir JSON.

HTTP metode ir GET.

  • klienta_atslega - klienta atslēga, kura tika Jums piešķirta.

Pieprasījuma parametri

Iespējams padot sekojošus GET parametrus:

Parametrs Skaidrojums Vērtības
search Ar komatu var padod ko meklēt LV, EE vai LT valstu abreviatūra un poligona numurs
groups Ar komatu var padod pasta indeksu grupas, ko meklēt Piemēram, "LV-10"
wgs84 Ja padots, tad būs atgriezti koordinātes EPSG:4326, pretējā gadījumā LKS-92
wkt Ja padots tad ģeometrija tiek atgriezta WKT formātā, pretējā gadījumā GeoJSON masīvā
union_mode Apvienošanas algoritms Pieejami 3 režīmi:
  • isolate – vienmēr katrs poligons atgriezts ka atsevišķs objekts;
  • collect – poligoni apvienoti vienā objekta, bet starp viņiem ir robeža;
  • union – poligoni apvienoti pilnībā, robežas nav.

Atbildes parametri

Atbildē tiek atgriezts masīvs ar objektiem, objektu parametri ir šādi:

Parametrs Skaidrojums
postal_code Masīvs ar pasta poligonu indeksiem, kurus tika atrasti pēc search parametra.
geometry Atrasto pasta poligonu ģeometrija WKT vai GeoJSON formātā, kas ir atkarīgs no definētā wkt parametra.

Paraugi

1. paraugs

Ievads: https://api.kartes.lv/v3/<klienta_atslega>/postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=union

Rezultāts:

[
  {
    "postal_code": [
      "LV-1021",
      "LV-1082"
    ],
    "geometry": "POLYGON((24.211844076502 56.952328567687,24.2123111802785 56.953430682896,24.2112963433119 56.9545393542733, ...))"
  }
]

2. paraugs

Ievads: https://api.kartes.lv/v3/<klienta_atslega>/postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=isolate

Rezultāts:

[
  {
    "postal_code": [
      "LV-1021"
    ],
    "geometry": "POLYGON((24.2469032114264 56.9567117634134,24.2456201489549 56.9568547474788,24.2415196809799 56.95731160475...))"
  },
  {
    "postal_code": [
      "LV-1082"
    ],
    "geometry": "POLYGON((24.211844076502 56.952328567687,24.2111411574187 56.9524309166326,24.210763974086 ...))"
  }
]

3. paraugs

Ievads: https://api.kartes.lv/v3/<klienta_atslega>/postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=collect

Rezultāts:

[
  {
    "postal_code": [
      "LV-1021",
      "LV-1082"
    ],
    "geometry": "MULTIPOLYGON(((24.2469032114264 56.9567117634134,24.2456201489549 56.9568547474788,24.2415196809799 56.95731160475,24.2414736991561 56.9573167270148,24.2387033682795 56.9576253024501 ...)))"
  }
]

4. paraugs

Ievads: https://api.kartes.lv/v3/<klienta_atslega>/postal_codes?search=LV-2167&groups=LV-10&wgs84&wkt&union_mode=union

Rezultāts:

[
  {
    "postal_code": [
      "LV-2167",
      "LV-1009",
      "LV-1050",
      ...
      "LV-1053"
    ],
    "geometry": "POLYGON((24.0702378727879 56.8792032859641,24.0693149401602 56.8792182722479,24.0674807921115 56.8792676685704 ... ))"
  }
]