Skip to main content

Інтеграційні АПІ

geocode​

АПІ для геокодування об'єктів за їх назвою,

reverse-geocode​

АПІ для оберненого геокодування об'єктів.

💡 Визначення оберненого геокодування

Обернене геокодування - це обернений процес до геокодування, коли нам потрібно отримати адресу місця розташування об'єкта за його координатами.

Схема запиту 

GET /api-user/reverse-geocode?x=<x>&y=<y>

Параметри​

ПараметрОпис
xКоордината довготи у системі координат EPSG:4326
yКоордината широти у системі координат EPSG:4326

Результат​

У результаті виконання запиту отримаємо два об'єкти, які містять інформацію про адресу місця розташування об'єкта від двох різних систем геокодування, а саме:

Приклад​

Приклад відповіді
{
  "here": {
    "items": [
      {
        "title": "Via di Porta Cavalleggeri, 71, 00165 Rome RM, Italy", // Назва місця
        "id": "here:af:streetsection:-mIf.iRKqBlDfek-zjPSdD:CggIBCCuquP2AhABGgI3MQ", // Унікальний ідентифікатор місця
        "resultType": "houseNumber", // Тип результату
        "houseNumberType": "PA", // Тип номеру будинку
        "address": {
          "label": "Via di Porta Cavalleggeri, 71, 00165 Rome RM, Italy", // Повна адреса
          "countryCode":" ITA", // Код країни
          "countryName": "Italy", // Назва країни
          "state": "Latium", // Назва області/штату
          "countyCode": "RM", // Код повіту
          "county": "Rome", // Назва повіту
          "city": "Rome", // Назва міста
          "district": "Aurelio", // Назва району
          "street": "Via di Porta Cavalleggeri", // Назва вулиці
          "postalCode": "00165", // Поштовий код
          "houseNumber": "71" // Номер будинку
        },
        "position":{ 
          "lat": 41.89991, // Широта
          "lng": 12.45449 // Довгота
        },
        "access": [
          {
            "lat": 41.89999, // Широта точки доступу
            "lng": 12.45443 // Довгота точки доступу
          }
        ],
        "distance": 3, // Відстань від запитуваної точки до місця
        "mapView": {
          "west": 12.45136, // Західна межа видимості
          "south": 41.89898, // Південна межа видимості
          "east": 12.45657, // Східна межа видимості
          "north": 41.90026 // Північна межа видимості
        }
      }
    ]
  },
  "map": {
    "type": "FeatureCollection", // Тип колекції
    "query": [12.45447,41.89993], // Координати запиту
    "features": [
      {
        "id": "address.989346741431486", // Унікальний ідентифікатор адреси
        "type": "Feature", // Тип об'єкта
        "place_type": ["address"], // Тип місця
        "relevance": 1, // Релевантність результату
        "properties": {
          "accuracy": "point", // Точність визначення місця
          "mapbox_id": "dXJuOm1ieGFkcjo5NjZjODY4My1hZDRmLTQ1NmEtOTI2Yi05MmFlZTUzMGI1MzQ" // Ідентифікатор Mapbox
        },
        "text": "Via Di Porta Cavalleggeri", // Назва вулиці
        "place_name": "Via Di Porta Cavalleggeri 67, 00165 Roma Rome, Italy", // Повна назва місця
        "center": [12.45446,41.900032], // Координати центру місця
        "geometry": {
          "type": "Point", // Тип геометрії
          "coordinates": [12.45446,41.900032] // Координати
        },
        "address": "67", // Номер будинку
        "context": [ // Контекстна інформація про місцезнаходження
          {
            "id": "postcode.989346741431486",
            "text": "00165" // Поштовий код
          }
        ]
      }
    ],
    "attribution": "NOTICE: © 2024 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service (https://www.mapbox.com/about/maps/). This response and the information it contains may not be retained. POI(s) provided by Foursquare." // Атрибуція Mapbox
  }
}

map-route​

weather​

АПІ інтеграції з сервісом openweathermap. Дана апі розроблена для отримання погодних умов у точці за її координатами

Схема запиту

GET /api-user/weather?x=<x>&y=<y>

Параметри​

ПараметрОпис
xКоордината довготи у системі координат EPSG:4326
yКоордината широти у системі координат EPSG:4326

Результат​

АПІ повертає об'єкт з описом погодних умов у заданій точці.

Приклад​

{
  "body": {
    "coord": {
      "lon": 12.4545, // Довгота місця
      "lat": 41.8999  // Широта місця
    },
    "weather": [
      {
        "id": 803, // Ідентифікатор погодних умов
        "main": "Clouds", // Основна характеристика погоди
        "description": "рвані хмари", // Детальний опис погоди
        "icon": "04d" // Іконка погоди
      }
    ],
    "base": "stations", // База даних
    "main": {
      "temp": 17.14, // Температура в градусах Цельсія
      "feels_like": 16.42, // Відчуття температури
      "temp_min": 15.16, // Мінімальна температура
      "temp_max": 17.86, // Максимальна температура
      "pressure": 1003, // Атмосферний тиск в гПа
      "humidity": 58 // Вологість у відсотках
    },
    "visibility": 7000, // Видимість в метрах
    "wind": {
      "speed": 9.26, // Швидкість вітру в м/с
      "deg": 220 // Напрямок вітру в градусах
    },
    "clouds": {
      "all": 75 // Хмарність у відсотках
    },
    "dt": 1705589296, // Час заміру в форматі Unix
    "sys": {
      "type": 1, // Тип системи
      "id": 6796, // Ідентифікатор системи
      "country": "VA", // Код країни (Ватикан)
      "sunrise": 1705559653, // Час сходу сонця в форматі Unix
      "sunset": 1705593966 // Час заходу сонця в форматі Unix
    },
    "timezone": 3600, // Зміщення часового поясу від UTC в секундах
    "id": 6691831, // Унікальний ідентифікатор місця
    "name": "Vatican City", // Назва місця
    "cod": 200 // Код відповіді API
  }
}

height​

АПІ інтеграції з сервісом opentopodata. Дана АПІ розроблена для отримання висоти за координатами

Схема запиту

GET /api-user/height?x=<x>&y=<y>

Параметри​

ПараметрОпис
xКоордината довготи у системі координат EPSG:4326
yКоордината широти у системі координат EPSG:4326

Приклад​

{
  "results": [
    {
      "dataset":"mapzen",
      "elevation":6260,
      "location": {
        "lat":-1.469167,
        "lng":-78.8175
      }
    }
  ],
  "status":"OK"
}

gis-url-proxy​

dzk​

АПІ інтеграції з ДЗК. АПІ розроблена для отримання земельної ділянки за кадастровим номером або за координатами

Схема запиту

// за кадастровим номером

GET /api-user/dzk?cad_num=<cad_num>
GET /api-user/dzk?cadNum=<cadNum>

// за координатами

GET /api-user/dzk?lng=<lng>&lat=<lat>
💡 Альтернативний виклик+

АПІ має альтернативний ендпоінт для виклику, а саме /api-user/dzk.api.

Параметри​

ПараметрОпис
cad_numКадастровий номер ділянки
cadNumАльтернативний спосіб вказання кадастрового номеру
lngКоордината довготи у системі координат EPSG:4326
latКоордината широти у системі координат EPSG:4326

Результат​

У відповідь на запит, ми отримаємо витяг про земельну ділянку у вигляду об'єкта

Приклад​

{
  "success": true, // чи був запит вдалим?
  "result": {
    "cadnum": "2621683700:04:001:0018", // кадастровий номер ділянки
    "category": "Землі сільськогосподарського призначення", // категорія призначення земельної ділянки
    "purpose_code": "01.01", // код призначення земельної ділянки
    "purpose": "01.01 Для ведення товарного сільськогосподарського виробництва", // призначення земельної ділянки
    "use": "для ведення товарного сільськогосподарського виробництва", // категорія використання земельної ділянки
    "area": "0.4124", // площа земельної ділянки
    "unit_area": "га", // одиниці виміру площі земельної ділянки
    "ownershipcode": "100", // код типу власника земельною ділянкою
    "ownership": "Приватна власність", // тип власника земельною ділянкою
    "address": null, // адреса земельної ділянки
    "geom": { // геометрія земельної ділянки у системі координат EPSG:4326 у вигляді geojson
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [25.321199189,48.800657011],
            [25.318971367,48.801739816],
            [25.319137555,48.801887738],
            [25.321365377,48.800804936],
            [25.321266563,48.800716181],
            [25.321199189,48.800657011]
          ]
        ]
      ]
    },
    "geom_centroid": { // геометрія центроїда земельної ділянки у системі координа EPSG:4326 у вигляді geojson
      "type": "Point",
      "coordinates": [25.320168519,48.801272303]
    }
  }
}

layer-setting​