OBGv4 (метод)

Материал из post-API.ru
Перейти к: навигация, поиск

Данный метод (аббр. - Objects By Geo) предназначен для поиска ближайших к заданным координатам адресных объектов.


Версия API

 Версия 4.0

Вызов

 http://api.post-api.ru:3300/api/v4/obg?apikey=dev&abc=2&long=37.77246&lat=55.90801&yandex=1&google=1&d=1

Параметры

Ключ Обязательный Описание
lat О Широта в градусах. В качестве разделителя целой и дробной части можно использовать как ".", так и ",".
long О Долгота в градусах. В качестве разделителя целой и дробной части можно использовать как ".", так и ",".
streets Н Если ключ установлен в "1" (по умолчанию), то в составе ответа возвращается список улиц streets. Каждая улица дополнена координатами центра и координатами углов квадрата, описывающего улицу. Все улицы расположены в порядке удаленности от заданных координат.
houses Н Если ключ установлен в "1" (по умолчанию), то в составе улиц (streets) возвращается список домов houses. Каждый дом дополнен географическими координатами.
geo Н Если ключ установлен в "0" (по умолчанию - "1"), то объекты streets и houses НЕ дополняются географическими координатами (но структура route все равно будет содержать их).
mkad Н Если ключ установлен в "1" (по умолчанию) и найдена "Московская область", то структура (route) дополняется информацией об удалении объекта от МКАД (mkad).
ex Н Если ключ установлен в "1" (по умолчанию - "0"), то среди улиц будут расположены объекты типа "гск" и "снт", имеющие aolevel = 90.
abc Н Если ключ установлен в "0" (по умолчанию), то сортировка домов внутри улиц осуществляется по правилам цифр (2 > 1 => true). Если в "1" - то по правилам строк ("7" > "20" => true). Если в "2", то дома расположены по удаленности от заданных lat,long.
yandex Н Если ключ установлен в "1" (по умолчанию - "0"), то каждый объект в ответе будет содержать ссылку на проект Яндекс.Карты, которая будет открывать карту на заданных координатах.
google Н Если ключ установлен в "1" (по умолчанию - "0"), то каждый объект в ответе будет содержать ссылку на проект Google.Maps, которая будет открывать карту на заданных координатах.
apikey О Ключ доступа к API.
d Н Отладочный режим.


Возвращаемое значение

С этим методом связаны следующие массивы-ответы: route, streets, houses, mkad.

При успешном выполнении запроса возвращается следующий массив-ответ.

 status:
   time: 0.011675896         - Время выполнения скрипта без учета сетевых задержек
   status: success           - Координаты распознаны, сформирован успешный ответ
   access: granted           - Доступ по ApiKey предоставлен
   debug: 1                  - Включен режим демонстрационного вывода данных
   v: '4.0'                  - Версия API
 source:
   method: OBG               - Вызванный метод
   lat: '55.9080120'         - Широта 
   long: '37.7724682'        - Долгота
   streets: 1                - Возвращать список ближайших улиц
   houses: 1                 - Дополнять каждую улицу списком домов
   geo: 1                    - Добавлять гео-координаты к каждому объекту
   mkad: 1                   - Дополнять route структурой mkad
   ex: 1                     - Исключать объекты с aolevel >= 90
   abc: 2                    - Сортировать дома по удаленности от заданных координат
   yandex: 1                 - Формировать ссылки на Яндекс.Карты
   google: 1                 - Формировать ссылки на Googles.Map
 content:                    - Результат работы скрипта: OBG Content
 error:
   errcode: 0                - Нет ошибки
   errmsg:                   - Текст ошибки
   errname: success          - Текстовое обозначение ошибки

При не успешном выполнении метода возвращается массив-ответ с ошибкой

 status:
   time: 0.095120291         - Время выполнения скрипта без учета сетевых задержек
   status: error             - Скрипт выполнен с ошибкой
   access: granted           - Доступ по ApiKey предоставлен
   debug: 1                  - Режим вывода отладочной информации включен
   v: '4.0'                  - Версия API
 source:
   method: OBG               - Вызванный метод
   lat: 55.908012            - Широта
   long: 0.0                 - Долгота указана с ОШИБКОЙ
   streets: 1                - Возвращать список ближайших улиц
   houses: 1                 - Дополнять каждую улицу списком домов
   geo: 1                    - Добавлять гео-координаты к каждому объекту
   mkad: 1                   - Дополнять route структурой mkad
   ex: 1                     - Исключать объекты с aolevel >= 90
   abc: 2                    - Сортировать дома по удаленности от заданных координат
   yandex: 1                 - Формировать ссылки на Яндекс.Карты
   google: 1                 - Формировать ссылки на Googles.Map
 content:                    - Пустая структура
 error:
   errcode: 161                 - Код ошибки
   errmsg: Не указана долгота   - Текст ошибки
   errname: no-long             - Текстовая метка ошибки


Особенности

  1. Возвращаются адресные объекты, расположенные, как правило, не далее 2,5 км от заданных координат
  2. С тестовым ключом "apikey=dev" количество возвращаемых значений ограничено 3 улицами без домов.
  3. Метод является экспериментальным, и останется таким всегда. Он может быть использован AS IS.
  4. Точность метода +- 50 м. То есть его не рекомендуется использовать в проектах, требующих точного отображения координат.
  5. Типовая скорость работы метода невысока, и составляет в среднем 1,2-1,5 секунды.


Обсуждение

 Нет

История

  • 04.10.2013 - Метод создан