Navicom Map Services Web API
http://maps.navicom.ru/nms/         Версия 1.8.0.2a       Июль 2017
GET/POST | SOAP (POST, WSDL) | XML-RPC (POST)
Методы:

- Тайлы -
  • Получение тайлов
  • Получение карты

  • - Геокодирование -
  • Получение словаря адресных объектов
  • Адресный поиск
  • Получение адресов по координатам
  • Получение регионов по координатам

  • - Маршруты -
  • Получение маршрута
  • Получение ближайшей дороги

  • Передаваемые структуры:
    tile | map | wms | wmts | list | address | xy2addr | xy2reg | route | nearroad

    Описание:
    tile | map | wms | wmts | list | address | xy2addr | xy2reg | route | nearroad

    Примеры использования:
    Тайлы, Поиск, Маршруты (LeafLet)
    Тайлы, Поиск, Маршруты со скоростью (LeafLet)
    Тайлы, Поиск, Маршруты (Google Maps API)
    Склееная карта (NaviMap)

    Сайты, использующие NMS Web API:
    Garmin POI
    Garmin Travel

    Только тайлы:
    Leaflet, Open Layers, Google Maps API 3, Yandex Maps API, Nokia Maps, Bing Maps

    Метод: tile
    HTTP GET ?key;x;y;zoom

    key - ключ доступа
    x, y, zoom - идентификатор тайла
    обязательные параметры:
    key, x, y, zoom
    зумы:
    1 - 17
    формат тайлов:
    256 х 256 PNG
    примеры:
    HTTP GET: tile?test;621;334;10
    примеры запросов:
    HTTP GET: Get Random Tile
    возвращает:
    image
    примеры подключения слоя:
    Leaflet, Open Layers, Google Maps API 3, Yandex Maps API 2, Nokia Maps, Bing Maps

    Метод: map
    HTTP GET ?key;lat;lon;zoom;wi;he

    key - ключ доступа
    lat, lon - центр карты
    zoom - зум
    wi, he - ширина и высота карты в пикселях
    обязательные параметры:
    key, lat, lon, zoom, wi, he
    ограничения:
    зумы: 1 - 17
    размеры: до 1600 пикселей по стороне и до 1440000 квд.пкс. площ.
    примеры:
    map?TEST;55.684;37.697;11;800;600
    примеры запросов:
    HTTP GET: Get Random Map
    возвращает:
    image
    примеры использования:
    NaviMap

    Метод: wms
    HTTP GET ?key=key
    - запрос картинки в формате WMS
    обязательные параметры:
    key - ключ доступа
    SERVICE=WMS
    REQUEST=GetMap
    SRS=EPSG:3857 (Spherical Mercator) или SRS=EPSG:4326 (WGS84)
    HEIGHT, WIDTH, BBOX
    ограничения:
    размеры: до 1600 пикселей по стороне и до 1440000 квд.пкс. площ.
    примеры:
    wms?key=TEST ...
    примеры использования:
    NaviMap
    возвращает:
    image

    Метод: wmts
    HTTP GET ?key=key
    - запрос картинки в формате WMS
    обязательные параметры:
    key - ключ доступа
    SERVICE=WMTS
    REQUEST=GetTile
    TileMatrixSet=EPSG:3857 (Spherical Mercator)
    TileMatrix={zoom}
    TileCol={y}
    TileRow={x}
    {x}, {y}, {zoom} - идентификатор тайла
    примеры:
    wmts?key=TEST ...
    примеры запросов:
    HTTP GET: Get Random Tile
    примеры использования:
    NaviMap
    возвращает:
    image

    Метод: list
    HTTP GET ?k=key&f=format&s=search_string&l=LonLeft&t=LatTop&r=LonRight&b=LatBottom

    параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [i] - вывод описания структур для запроса через ?json и ?xml
    search_string - строка для поиска (обязательный параметр)
    LonLeft - Долгота, западная координата (по умолчанию 0)
    LatTop - Широта, северная координата (по умолчанию 90)
    LonRight - Долгота, восточная координата (по умолчанию 180)
    LatBottom - Широта, южная координата (по умолчанию 0)
    обязательные параметры:
    key, search_string
    примеры:
    HTTP GET: list?k=test&f=0&s=еле
    HTTP GET: list?k=test&f=1&s=еле
    HTTP GET: list?k=test&f=2&s=еле
    HTTP GET: list?k=test&f=old&s=еле
    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O)

    Адресный поиск [HTTP GET] [HTTP POST]
    Метод: address
    HTTP GET ?k=key&f=format&s=search_string&n=moreNumbers&start=startNo&end=endNo&l=LonLeft&t=LatTop&r=LonRight&b=LatBottom&wts=WhatToSearch&x=LonSortBy&y=LatSortBy

    параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [i] - вывод описания структур для запроса через ?json и ?xml
    search_string - строка для поиска (обязательный параметр)
    moreNumbers - расширенный вывод домов (по умолчанию 0)
    - 0 - обычный вывод
    - 1 - список домов начинающихся на указанный номер (например, Ленина 1) работает по типу NUMBER LIKE '1%'
    startNo - задает стартовый порядковый номер точки при выводе (максимально возможное кол-во выводимых точек - 100, по умолчанию 1)
    endNo - задает конечный порядковый номер при выводе (максимально возможное кол-во выводимых точек - 100, по умолчанию 100)
    LonLeft - Долгота, западная координата (по умолчанию 0)
    LatTop - Широта, северная координата (по умолчанию 90)
    LonRight - Долгота, восточная координата (по умолчанию 180)
    LatBottom - Широта, южная координата (по умолчанию 0)
    whatToSearch - битовый флаг (или текст) что выводить (по умолчанию 31)
    - [1] или [h] - дома (bin 0000001, hex 0x01)
    - [2] или [s] - улицы (bin 00000010, hex 0x02)
    - [4] или [c] - населенные пункты (bin 00000100, hex 0x04)
    - [8] или [p] - POI (bin 00001000, hex 0x08)
    - [7] или [hsc] - всё (bin 00000111 :: 0x07)
    - [15] или [hscp] - всё + POI (bin 00001111 :: 0x0F)
    x - cортировать по удаленности от точки (Lon)
    y - cортировать по удаленности от точки (Lat)
     
    По умолчанию идет сортировка по релевантности и по алфавиту. Если заданы XY, то результат будет выведен в порядке удаленности от заданной точки. Если XY не заданы, но задан прямоугольник карты, то в результате выводится рассояние от центра прямоугольника. Если ни то, ни то не задано - выводится расстояние от первой точки результата.
     
    Поиск в населенном пункте:
    ленина в:Липецк (искать ленина в городе Липецк)
    Поиск в регионе:
    ленина region:10 (искать ленина в регионе с индексом 10, по классификатору mapsupport)
    Вывод адреса в виде массива строк:
    Порядок строк следующий: 0 - страна, 1 - регион, 2 - район, 3 - город, 4 - улица, 5 - дом
     
    обязательные параметры:
    key, search_string
    примеры:
    HTTP GET: address?k=test&f=txt&wts=hs&s=октябрь 1&n=0
    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O)
    поиск:
    возвращает:



    Примеры работы с адресным поиском:
    LeafLet, Google Maps

    Метод: xy2addr
    HTTP GET ?k=key&f=format&x=lon1,lon2,...,lonN&y=lat1,lat2,...,latN

    параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [3] или [r] или [region] - вывод только номера региона, в который попадает точка
    - [i] - вывод описания структур для запроса через ?json и ?xml
    x - Lon[] - массив через запятую
    y - Lat[] - массив через запятую
    обязательные параметры:
    key, x, y
    примеры:
    HTTP GET: ?k=test&f=txt&y=52.0638,52.0738&x=39.7488,39.7411
    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O)
    возвращает:


    Метод: xy2reg
    HTTP GET ?k=key&f=format&x=lon1,lon2,...,lonN&y=lat1,lat2,...,latN

    параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [3] или [r] или [region] - вывод только номера региона, в который попадает точка
    - [i] - вывод описания структур для запроса через ?json и ?xml
    x - Lon[] - массив через запятую
    y - Lat[] - массив через запятую
    обязательные параметры:
    key, x, y
    примеры:
    HTTP GET: ?k=test&f=txt&y=52.0638,52.0738&x=39.7488,39.7411
    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O)
    возвращает:


    Метод: route
    HTTP GET ?k=key&f=format&p=polyline&i=instructions &ct=userCurrentTraffic&ht=userHistoryTraffic &t=startTime&x=lon[]&y=lat[]&n=name[]&minby=time/dist&o=optimize
    &er=excludeLinesInRadius &ey=excludeLinesFromPointY[] &ex=excludeLinesFromPointX[] &ra=roadAttributes


    параметры

    основные параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [3] или [k] или [kml]
    - [4] или [g] или [geojson]
    - [i] - вывод описания структур для запроса через ?json и ?xml
    p - запрашивать полилинию маршрута (0/1, по умолчанию 1)
    i - запрашивать инструкции к маршруту (0/1, по умолчанию 1)
    ct - строить маршрут с учетом текущего трафика
    ht - строить маршрут с учетом исторического трафика
    t - время начала маршрута (dd.MM.yyyy HH:mm)
    x - долгота (массив через запятую)
    y - широта (массив через запятую)
    n - имена точек (массив через запятую)

    оптимизация маршрута:
    minby - оптимизировать маршрут по времени/расстоянию (time/dist, по умолчанию time)

    оптимизация промежуточных точек:
    o - оптимизировать порядок обхода промежуточных точек (0/1, по умолчанию 0)

    избегать проезд через участки (точки):
    ex - долгота (для точек, которые необходимо избегать; массив через запятую)
    ey - широта (для точек, которые необходимо избегать; массив через запятую)
    er - избегать дороги на расстоянии от указанных точек `ex` и `ey` (в метртах; 1000 м максимум; по умолчанию 50 м)

    избегать определенные дороги (участки дорог):
    ra - параметры построения маршрута в зависимости от характеристик дорог (см. описание)

    Комментарий: Параметры `er`,`ex`,`ey` и`ra` работают только при построении маршрута
    в начальном, конечном регионе, а также в регионах где есть промежуточные точки.
    Если маршрут проходит через 3 региона и более в транзитных регионах при расчете
    маршрута заданные условия не учитываются! При необходимости такого расчета следует
    использовать промежуточные точки.

    обязательные параметры:
    key, x, y

    примеры:
    HTTP GET: route?k=test&f=2&minby=time&x=39.5685,39.5788&y=52.59708,52.63228&n=start_A,destination_A
    HTTP GET: route?k=test&f=2&minby=time&x=39.5685,39.5788,39.5685&y=52.59708,52.63228,52.59708&n=start_A,destination_A,return_A
    HTTP GET: route?k=test&f=2&minby=dist&x=39.5685,39.5788&y=52.59708,52.63228&n=start_A,destination_A
    HTTP GET: route?k=test&f=4&minby=time&x=39.5685,39.5788&y=52.59708,52.63228&n=start_A,destination_A
    HTTP GET: route?k=test&f=2&x=39.5685,39.5788&y=52.59708,52.63228&n=start_B,destination_B&er=150&ey=55.41,55.42&ex=37.31,37.32

    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O), GeoJSON, KML

    возвращает:


    - driveLength - общая длина маршрута в метрах (от начальной до конечной точки);
    - driveLengthSegments - длина маршрута от начальной точки до каждой точки пути, включая начальную точку;
    - driveTime - общее время движения по маршруту в минутах (от начальной до конечной точки);
    - driveTimeSegments - время движения по маршруту от начальной точки до каждой точки пути, включая начальную точку;
    - stops - список точек пути (включая начальную точку) в порядке обхода (в случае оптимизации порядок может меняться);
    - instructions - описание движения по маршруту;
    - instructionsSegments - индекс, указывающий на элемент массива instructions, соответствующий каждой точке пути, включая начальную точку;
    - polyline - вектор маршрута;
    - polylineSegments - индекс, указывающий на элемент массива polyline, соответствующий каждой точке пути, включая начальную точку;

    Примеры работы с маршрутами:
    LeafLet, Google Maps

    Метод: nearroad
    HTTP GET ?k=key&f=format&n=names&x=lon[]&y=lat[]

    параметры:
    key - ключ доступа (обязательный параметр)
    format - формат вывода результата (по умолчанию 0)
    - [0] или [j] или [json]
    - [1] или [t] или [txt]
    - [2] или [x] или [xml]
    - [i] - вывод описания структур для запроса через ?json и ?xml
    n - запрашивать названия дорог (0/1, по умолчанию 0)
    x - долгота (массив через запятую)
    y - широта (массив через запятую)
    обязательные параметры:
    key, x, y
    примеры:
    HTTP GET: nearroad?k=TEST&f=json&x=39.566334145326486,39.609832763671875,37.39,49.49,37.15,37.38&y=52.61555643344044,52.61555643344044,55.45,57.82,55.47,55.45
    структуры и примеры запросов:
    HTTP POST: JSON (I/O), XML (I/O), SOAP (I/O), XML-RPC (I/O)
     
    Заголовки клиента:
    Response-Indented: true - сервер возвращает данные разделенные переводом строк (\r\n)
    Response-Encoding: utf-8 - сервер возвращает данные в заданной кодировке (например, utf-8, windows-1251, 1251, cp866, 866; по умолчанию utf-8)

    Copyrights © ЗАО Навиком 2012 - 2017
    www.navicom.ru
    main page