Веб-сервисы — различия между версиями

Материал из Меасофт
Перейти к: навигация, поиск
(Информирование системы о поступивших заказах)
(Геокодирование)
(не показано 39 промежуточных версий 3 участников)
Строка 1: Строка 1:
Все ссылки на дополнительные сервисы содержат экстра_код. Экстра код - это ваш уникальный [[Личный кабинет курьерской службы#Подключение|код курьерской службы]].
+
[[Файл:калькулятор.png|right|300×100px|thumb|Калькулятор]]
 +
[[Файл:трекинг.png|right|300px|thumb|Трекинг по номеру]]
 +
Все ссылки на дополнительные сервисы содержат '''экстра_код'''. Экстра код - это ваш уникальный [[Личный кабинет курьерской службы#Подключение|код курьерской службы]].
  
 
Дополнительными сервисами может воспользоваться любой клиент курьерской службы. Для этого ему не нужно иметь доступ в [[Личный кабинет|личный кабинет]], достаточно перейти по нужной ссылке.  
 
Дополнительными сервисами может воспользоваться любой клиент курьерской службы. Для этого ему не нужно иметь доступ в [[Личный кабинет|личный кабинет]], достаточно перейти по нужной ссылке.  
  
 
==Калькулятор==
 
==Калькулятор==
“Калькулятор” доступен по ссылке вида '''home.courierexe.ru/экстра_код/calculator'''. Сервис предназначен для расчета стоимости доставки, работает аналогично [[Настройка личного кабинета#Настройка пункта “Калькулятор”|калькулятору]] в личном кабинете.
+
"Калькулятор" доступен по ссылке вида '''home.courierexe.ru/экстра_код/calculator'''. Сервис предназначен для расчета стоимости доставки, работает аналогично [[Личный кабинет курьерской службы#Настройка пункта "Калькулятор"|калькулятору]] в личном кабинете.
  
 
==Трекинг по номеру==
 
==Трекинг по номеру==
“Трекинг по номеру” позволяет отслеживать заказ по его номеру. Сервис доступен по ссылке вида '''home.courierexe.ru/код_экстра_клиента/tracking'''.  
+
"Трекинг по номеру" позволяет отслеживать заказ по его номеру. Сервис доступен по ссылке вида '''home.courierexe.ru/экстра_код/tracking'''. При поиске заказа выводится таблица с подробностями. Поля таблицы настраиваются в "[[Личный кабинет курьерской службы#Настройка полей|админке]]" на вкладке "Поля трекинга по номеру".  
  
Чтобы вывести информацию о заказе, введите его номер в поле “Код” и нажмите кнопку “Найти”.  
+
Чтобы получить информацию о заказе, введите его номер в поле "Код" и нажмите кнопку "Найти".
  
==Внешний интерфейс сотрудников==
+
==Отзывы==
Внешний интерфейс сотрудников позволяет без входа в систему MeaSoft вносить информацию о доставке заказов по накладным, добавлять/редактировать собеседования.
+
[[Файл:Отзыв1.PNG|right|300px|thumb|Отзывы: оценка в виде звёздочек и комментарий]]
 
+
Сервис позволяет запрашивать у клиентов отзывы к работе курьерской службы, в том числе к заказам, к курьерам, к сообщениям и т.д.  
Сервис доступен по ссылке вида '''home.courierexe.ru/экстра_код/staff'''. Для входа используются те же логин и пароль, что и для <rspoiler text="входа в систему MeaSoft">Сотрудник должен быть зарегистрирован в системе MeaSoft как пользователь (“Настройка” &rarr; “Пользователи”)</rspoiler>.
 
  
===Адреса===
+
Отзывы могут быть нескольких типов:
===Собеседования===
 
Пункт основного меню “Собеседования” предназначен для добавления и редактирования [[Собеседования|собеседований]].
 
  
Вверху справа можно отфильтровать собеседования по дате, имени (поле “Поиск”). Правее с помощью галок выбираются столбцы, которые будут отображаться в таблице. Также можно выбрать количество собеседований, отображаемых на странице.  
+
* оценка (в т.ч. в виде звёздочек);
 +
* комментарий;
 +
* оценка и комментарий;
 +
* отзыв типа хорошо/плохо.
  
Чтобы отредактировать собеседование, нажмите на соответствующую строку и в открывшемся окне внесите необходимые изменения. 
+
Для работы сервиса сформируйте ссылку вида '''home.courierexe.ru/экстра-код/opinions''' с параметрами:
 
 
===Колл-центр===
 
===Приглашенные===
 
 
 
==Отзывы==
 
Сервис доступен по ссылке '''https://home.courierexe.ru/8/opinions''' с параметрами:
 
  
 
*'''code''' - внутренний код сущности в системе. Обязательный параметр.
 
*'''code''' - внутренний код сущности в системе. Обязательный параметр.
*'''rate''' - оценка. Для заказов параметр должен быть равен коду из справочника Жалобы. Для остальных типов - целое число от 1 до 5.
+
*'''rate''' - <rspoiler text="оценка">При наличии параметра rate оценка проставляется сразу и в форме не запрашивается. Обычно создаются две ссылки, одной из которых присвоено значение rate = 1, а другой - rate = 5. Таким образом формируется тип отзыва "хорошо/плохо", когда у клиента на выбор только две оценки. Возможно как с запросом комментария, так и без него. </rspoiler>. Для заказов параметр должен быть равен коду из справочника [[Справочники#Жалобы клиентов|Жалобы]]. Для остальных типов - целое число от 1 до 5.  
*'''type''' - тип сущности. По умолчанию 3.
+
*'''type''' - тип сущности. По умолчанию 3 (заказ).
 
*'''note''' - признак ввода комментария. По умолчанию 1.
 
*'''note''' - признак ввода комментария. По умолчанию 1.
 
*'''star''' - признак вывода в виде звёздочек. По умолчанию 1.
 
*'''star''' - признак вывода в виде звёздочек. По умолчанию 1.
 
*'''hash''' - значение хэша ссылки. Хэш генерируется функцией [[Руководство программиста#Хеширование|SignatureUrl]]. Обязательный параметр.
 
*'''hash''' - значение хэша ссылки. Хэш генерируется функцией [[Руководство программиста#Хеширование|SignatureUrl]]. Обязательный параметр.
 
+
*'''field''' - Пользовательское поле, для указания типа отзыва.
При наличии параметра rate оценка проставляется сразу и в форме не запрашивается.
 
  
  
 
Примеры запросов (без хэша):
 
Примеры запросов (без хэша):
  
https://home.courierexe.ru/8/opinions?code=123456 Запрос оценки в виде звёздочек и комментария для адреса (type = 3, note = 1, star = 1)
+
'''home.courierexe.ru/экстра-код/opinions?code=123456''' Запрос оценки в виде звёздочек и комментария для адреса (type = 3, note = 1, star = 1).
  
https://home.courierexe.ru/8/opinions?code=123456&rate=1 Запрос комментария для адреса (оценка уже проставлена)
+
'''home.courierexe.ru/экстра-код/opinions?code=123456&rate=1''' Запрос комментария для адреса (оценка уже проставлена).
  
https://home.courierexe.ru/8/opinions?code=123456&star=0 Запрос оценки в виде списка и комментария для адреса
+
'''home.courierexe.ru/экстра-код/opinions?code=123456&star=0''' Запрос оценки в виде списка и комментария для адреса.
  
https://home.courierexe.ru/8/opinions?code=123456&type=12 Запрос оценки сотрудника в виде звёздочек с комментарием
+
'''home.courierexe.ru/экстра-код/opinions?code=123456&type=12''' Запрос оценки сотрудника в виде звёздочек с комментарием.
  
https://home.courierexe.ru/8/opinions?code=123456&rate=1&note=0 Оценка выставлена, комментарий не запрашивается, сразу выводится сообщение о выставленной оценке.
+
'''home.courierexe.ru/экстра-код/opinions?code=123456&rate=1&note=0''' Оценка выставлена, комментарий не запрашивается, сразу выводится сообщение о выставленной оценке.
  
  
Для уменьшения длины ссылки можно использовать короткую форму записи метода и параметров:
+
Для уменьшения длины ссылки можно использовать короткую форму записи метода и параметров (наименования параметров сокращаются до одной буквы):
  
https://home.courierexe.ru/8/o?c=123456&r=1&n=1&t=3
+
home.courierexe.ru/экстра-код/'''o'''?'''c'''=123456&'''r'''=1&'''n'''=1&'''t'''=3
  
 
==Информирование системы о поступивших заказах==
 
==Информирование системы о поступивших заказах==
 
[[Файл:информ.новые_заказы.png|right|300px|thumb|Подключение окна уведомлений о заказах]]
 
[[Файл:информ.новые_заказы.png|right|300px|thumb|Подключение окна уведомлений о заказах]]
  
В системе MeaSoft есть возможность включить автоматические уведомления о поступивших заказах из [[Личный кабинет клиента|ЛК клиента]]/[[API|API-интерфейса]]. Для этого в основном меню выберите "Настройка" &rarr; "Пользователи" &rarr; карточка пользователя &rarr; "Настройка", '''поставьте галку''' "Показывать окно поступивших заказов" и нажмите "ОК".  
+
В системе MeaSoft есть возможность включить автоматические уведомления о заказах, поступающих из [[Личный кабинет клиента|ЛК клиента]]/[[API|API-интерфейса]]. Для этого в основном меню выберите "Настройка" &rarr; "Пользователи" &rarr; карточка пользователя &rarr; "Настройка", '''поставьте галку''' '''"Показывать окно поступивших заказов"''' и нажмите "ОК".  
  
 
В результате у выбранного пользователя в системе  MeaSoft каждые 10 минут будет появляться окно со списком новых заказов и двумя кнопками: "Перейти (Прочитан)" и "Закрыть".   
 
В результате у выбранного пользователя в системе  MeaSoft каждые 10 минут будет появляться окно со списком новых заказов и двумя кнопками: "Перейти (Прочитан)" и "Закрыть".   
Строка 69: Строка 64:
  
 
Чтобы очистить список заказов из окна уведомлений, нажмите кнопку "'''Прочитан'''".
 
Чтобы очистить список заказов из окна уведомлений, нажмите кнопку "'''Прочитан'''".
 +
 +
==Внешний интерфейс сотрудников (Staff)==
 +
[[Файл:Внешний_интерфейс.PNG|right|300px|thumb|Внешний интерфейс сотрудников]]
 +
Staff позволяет без входа в систему MeaSoft вносить информацию о доставке заказов по накладным, добавлять/редактировать собеседования, получать заказы на прозвон, а также вести учет по приглашенным клиентам. 
 +
 +
Сервис доступен по ссылке вида '''home.courierexe.ru/экстра_код/staff'''. Для входа используются те же логин и пароль, что и для <rspoiler text="входа в систему MeaSoft">Сотрудник должен быть зарегистрирован в системе MeaSoft как пользователь ("Настройка" &rarr; "Пользователи")</rspoiler>.
 +
 +
===Адреса===
 +
Пункт основного меню "Адреса" позволяет удаленному сотруднику вносить в корреспонденции информацию о доставке из отсканированных накладных. По умолчанию в "Адресах" отображается список заказов в виде таблицы.
 +
 +
Чтобы внести информацию о доставке, нажмите на строку заказа. Откроется окно, вверху которого скан накладной, а внизу - форма для внесения данных. Заполните ее и нажмите кнопку "Сохранить". Заказ исчезнет из списка адресов.
 +
 +
Таблица заказов содержит следующие столбцы:
 +
 +
'''#''' - внутренний код staff’а.
 +
 +
'''Фирма''' – компания получателя.
 +
 +
'''Адрес''' – адрес получателя.
 +
 +
'''Заказ''' – номер заказа с вкладки "Заказы".
 +
 +
'''Номер''' – значение столбца "Номер" с вкладки "Адреса".
 +
 +
'''Шифр''' – шифр корреспонденции.
 +
 +
Вверху справа можно выполнить поиск корреспонденции.
 +
 +
Заказ попадает в список "Адресов" в случае, если:
 +
 +
#Он не старше 2 месяцев.
 +
#В поле "Инфо о доставке" введено слово "Скан".
 +
#К заказу прикреплен [[Функции|скан накладной]] с заполненной информацией о доставке. Имя файла должно быть "scan.jpg".
 +
 +
===Собеседования===
 +
Пункт основного меню "Собеседования" предназначен для добавления и редактирования [[Собеседования|собеседований]].
 +
 +
Вверху справа можно отфильтровать собеседования по дате, имени (поле "Поиск"). Правее с помощью галок выбираются столбцы, которые будут отображаться в таблице. Также можно выбрать количество собеседований, выводимых на страницу.
 +
 +
Чтобы добавить собеседование, нажмите кнопку "Добавить", в открывшемся окне внесите необходимую информацию и нажмите "Сохранить".
 +
 +
Чтобы отредактировать собеседование, нажмите на соответствующую строку и в открывшемся окне внесите необходимые изменения.
 +
[[Файл:Колл центр.png|right|300px|thumb|Пункт меню "Колл-центр"]]
 +
 +
===Колл-центр===
 +
Пункт основного меню "Колл-центр" позволяет удаленному сотруднику получать заказы на прозвон клиентов. В список заказов попадают проекты, созданные в [[Личный кабинет курьерской службы|ЛК курьерской службы]].
 +
 +
При нажатии кнопки "'''Получить'''" открывается окно с задачей на совершение звонка. Справа отображается описание проекта, слева - форма для просмотра и редактирования данных. Если сотрудник дозвонился по указанному в форме номеру, он должен заполнить пустые поля и внизу нажать кнопку "'''Сохранить'''". Если дозвониться не удалось, необходимо нажать кнопку "'''Не дозвонились'''".  Нажатие кнопки "'''Отменить'''" возвращает заказ в список непрозвоненных.
 +
[[Файл:Приведенные.PNG|right|300px|thumb|Назначение сотрудника менеджером в системе MeaSoft]]
 +
 +
===Приглашенные===
 +
Пункт основного меню "Приглашенные" предназначен для удаленных сотрудников, которые получают вознаграждение за приведенных клиентов. Здесь они могут видеть таблицу со списком приглашенных клиентов и размером своего вознаграждения за их заказы. Вверху справа можно отфильтровать клиентов по дате. Нажатие на строку таблицы открывает окно с детализацией заказов.
 +
 +
В системе MeaSoft такой сотрудник должен быть назначен [[Сотрудники#Виды сотрудников|агентом]], а также указан менеджером на вкладке "Основное" в <rspoiler text="карточке клиента">"Клиенты" &rarr; карточка клиента &rarr; вкладка "Основное" &rarr; поле "Менеджер" </rspoiler>, которого он привёл. Там же в поле "% менеджера" указывается размер вознаграждения агента в виде процента от заказов.
 +
 +
 +
==Геокодирование==
 +
 +
 +
Геокодирование выполняется запросом к серверу на адрес:
 +
 +
http://home.courierexe.ru/geocoder
 +
 +
GET-параметры:
 +
 +
* '''geocoder''' - в данном параметре может использоваться как полный адрес для разбора, так и в составе других параметров
 +
* '''town''' - город
 +
* '''address''' - адрес
 +
* '''street''' - улица
 +
* '''home''' - номер дома
 +
* '''extracode''' - дополнительный параметр, зависит от клиента
 +
 +
 +
Результатом является ответ в формате XML, например:
 +
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<ymaps>
 +
  <GeoObjectCollection>
 +
    <featureMember>
 +
      <GeoObject>
 +
        <metaDataProperty>
 +
          <GeocoderMetaData>
 +
            <kind>house</kind>
 +
          </GeocoderMetaData>
 +
        </metaDataProperty>
 +
        <name>ул. Сталеваров, 20</name>
 +
        <Point>
 +
          <pos>37.8389496 55.754736</pos>
 +
          <kind>house</kind>
 +
          <zipcode>house</zipcode>
 +
          <distance>house</distance>
 +
        </Point>
 +
      </GeoObject>
 +
    </featureMember>
 +
  </GeoObjectCollection>
 +
</ymaps>
 +
</source>
 +
 +
Параметры ответа:
 +
 +
* '''name''' - найденный адрес
 +
* '''pos''' - геокоординаты - долгота и широта
 +
* '''kind''' - найденный элемент является домом, если значение house
 +
* '''zipcode''' - индекс найденного объекта
 +
* '''distance''' - расстояние до МКАД/КАД в метрах
 +
 +
 +
Ответ в случае, если адрес не геокодирован
 +
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<ymaps>
 +
  <error>
 +
    <status>429</status>
 +
    <message>Coordinates aren't found</message>
 +
  </error>
 +
</ymaps>
 +
</source>

Версия 11:39, 3 июля 2020

Калькулятор
Трекинг по номеру

Все ссылки на дополнительные сервисы содержат экстра_код. Экстра код - это ваш уникальный код курьерской службы.

Дополнительными сервисами может воспользоваться любой клиент курьерской службы. Для этого ему не нужно иметь доступ в личный кабинет, достаточно перейти по нужной ссылке.

Калькулятор

"Калькулятор" доступен по ссылке вида home.courierexe.ru/экстра_код/calculator. Сервис предназначен для расчета стоимости доставки, работает аналогично калькулятору в личном кабинете.

Трекинг по номеру

"Трекинг по номеру" позволяет отслеживать заказ по его номеру. Сервис доступен по ссылке вида home.courierexe.ru/экстра_код/tracking. При поиске заказа выводится таблица с подробностями. Поля таблицы настраиваются в "админке" на вкладке "Поля трекинга по номеру".

Чтобы получить информацию о заказе, введите его номер в поле "Код" и нажмите кнопку "Найти".

Отзывы

Отзывы: оценка в виде звёздочек и комментарий

Сервис позволяет запрашивать у клиентов отзывы к работе курьерской службы, в том числе к заказам, к курьерам, к сообщениям и т.д.

Отзывы могут быть нескольких типов:

  • оценка (в т.ч. в виде звёздочек);
  • комментарий;
  • оценка и комментарий;
  • отзыв типа хорошо/плохо.

Для работы сервиса сформируйте ссылку вида home.courierexe.ru/экстра-код/opinions с параметрами:

  • code - внутренний код сущности в системе. Обязательный параметр.
  • rate - оценка
    . Для заказов параметр должен быть равен коду из справочника Жалобы. Для остальных типов - целое число от 1 до 5.
  • type - тип сущности. По умолчанию 3 (заказ).
  • note - признак ввода комментария. По умолчанию 1.
  • star - признак вывода в виде звёздочек. По умолчанию 1.
  • hash - значение хэша ссылки. Хэш генерируется функцией SignatureUrl. Обязательный параметр.
  • field - Пользовательское поле, для указания типа отзыва.


Примеры запросов (без хэша):

home.courierexe.ru/экстра-код/opinions?code=123456 Запрос оценки в виде звёздочек и комментария для адреса (type = 3, note = 1, star = 1).

home.courierexe.ru/экстра-код/opinions?code=123456&rate=1 Запрос комментария для адреса (оценка уже проставлена).

home.courierexe.ru/экстра-код/opinions?code=123456&star=0 Запрос оценки в виде списка и комментария для адреса.

home.courierexe.ru/экстра-код/opinions?code=123456&type=12 Запрос оценки сотрудника в виде звёздочек с комментарием.

home.courierexe.ru/экстра-код/opinions?code=123456&rate=1&note=0 Оценка выставлена, комментарий не запрашивается, сразу выводится сообщение о выставленной оценке.


Для уменьшения длины ссылки можно использовать короткую форму записи метода и параметров (наименования параметров сокращаются до одной буквы):

home.courierexe.ru/экстра-код/o?c=123456&r=1&n=1&t=3

Информирование системы о поступивших заказах

Подключение окна уведомлений о заказах

В системе MeaSoft есть возможность включить автоматические уведомления о заказах, поступающих из ЛК клиента/API-интерфейса. Для этого в основном меню выберите "Настройка" → "Пользователи" → карточка пользователя → "Настройка", поставьте галку "Показывать окно поступивших заказов" и нажмите "ОК".

В результате у выбранного пользователя в системе MeaSoft каждые 10 минут будет появляться окно со списком новых заказов и двумя кнопками: "Перейти (Прочитан)" и "Закрыть".

Чтобы временно скрыть окно, нажмите кнопку "Закрыть".

Чтобы открыть список новых заказов на вкладке "Адреса", нажмите кнопку "Перейти". После этого кнопка "Перейти" сменится на "Прочитан".

Чтобы очистить список заказов из окна уведомлений, нажмите кнопку "Прочитан".

Внешний интерфейс сотрудников (Staff)

Внешний интерфейс сотрудников

Staff позволяет без входа в систему MeaSoft вносить информацию о доставке заказов по накладным, добавлять/редактировать собеседования, получать заказы на прозвон, а также вести учет по приглашенным клиентам.

Сервис доступен по ссылке вида home.courierexe.ru/экстра_код/staff. Для входа используются те же логин и пароль, что и для входа в систему MeaSoft
.

Адреса

Пункт основного меню "Адреса" позволяет удаленному сотруднику вносить в корреспонденции информацию о доставке из отсканированных накладных. По умолчанию в "Адресах" отображается список заказов в виде таблицы.

Чтобы внести информацию о доставке, нажмите на строку заказа. Откроется окно, вверху которого скан накладной, а внизу - форма для внесения данных. Заполните ее и нажмите кнопку "Сохранить". Заказ исчезнет из списка адресов.

Таблица заказов содержит следующие столбцы:

# - внутренний код staff’а.

Фирма – компания получателя.

Адрес – адрес получателя.

Заказ – номер заказа с вкладки "Заказы".

Номер – значение столбца "Номер" с вкладки "Адреса".

Шифр – шифр корреспонденции.

Вверху справа можно выполнить поиск корреспонденции.

Заказ попадает в список "Адресов" в случае, если:

  1. Он не старше 2 месяцев.
  2. В поле "Инфо о доставке" введено слово "Скан".
  3. К заказу прикреплен скан накладной с заполненной информацией о доставке. Имя файла должно быть "scan.jpg".

Собеседования

Пункт основного меню "Собеседования" предназначен для добавления и редактирования собеседований.

Вверху справа можно отфильтровать собеседования по дате, имени (поле "Поиск"). Правее с помощью галок выбираются столбцы, которые будут отображаться в таблице. Также можно выбрать количество собеседований, выводимых на страницу.

Чтобы добавить собеседование, нажмите кнопку "Добавить", в открывшемся окне внесите необходимую информацию и нажмите "Сохранить".

Чтобы отредактировать собеседование, нажмите на соответствующую строку и в открывшемся окне внесите необходимые изменения.

Пункт меню "Колл-центр"

Колл-центр

Пункт основного меню "Колл-центр" позволяет удаленному сотруднику получать заказы на прозвон клиентов. В список заказов попадают проекты, созданные в ЛК курьерской службы.

При нажатии кнопки "Получить" открывается окно с задачей на совершение звонка. Справа отображается описание проекта, слева - форма для просмотра и редактирования данных. Если сотрудник дозвонился по указанному в форме номеру, он должен заполнить пустые поля и внизу нажать кнопку "Сохранить". Если дозвониться не удалось, необходимо нажать кнопку "Не дозвонились". Нажатие кнопки "Отменить" возвращает заказ в список непрозвоненных.

Назначение сотрудника менеджером в системе MeaSoft

Приглашенные

Пункт основного меню "Приглашенные" предназначен для удаленных сотрудников, которые получают вознаграждение за приведенных клиентов. Здесь они могут видеть таблицу со списком приглашенных клиентов и размером своего вознаграждения за их заказы. Вверху справа можно отфильтровать клиентов по дате. Нажатие на строку таблицы открывает окно с детализацией заказов.

В системе MeaSoft такой сотрудник должен быть назначен агентом, а также указан менеджером на вкладке "Основное" в карточке клиента
, которого он привёл. Там же в поле "% менеджера" указывается размер вознаграждения агента в виде процента от заказов.


Геокодирование

Геокодирование выполняется запросом к серверу на адрес:

http://home.courierexe.ru/geocoder

GET-параметры:

  • geocoder - в данном параметре может использоваться как полный адрес для разбора, так и в составе других параметров
  • town - город
  • address - адрес
  • street - улица
  • home - номер дома
  • extracode - дополнительный параметр, зависит от клиента


Результатом является ответ в формате XML, например:

<?xml version="1.0" encoding="UTF-8"?>
<ymaps>
  <GeoObjectCollection>
    <featureMember>
      <GeoObject>
        <metaDataProperty>
          <GeocoderMetaData>
            <kind>house</kind>
          </GeocoderMetaData>
        </metaDataProperty>
        <name>ул. Сталеваров, 20</name>
        <Point>
          <pos>37.8389496 55.754736</pos>
          <kind>house</kind>
          <zipcode>house</zipcode>
          <distance>house</distance>
        </Point>
      </GeoObject>
    </featureMember>
  </GeoObjectCollection>
</ymaps>

Параметры ответа:

  • name - найденный адрес
  • pos - геокоординаты - долгота и широта
  • kind - найденный элемент является домом, если значение house
  • zipcode - индекс найденного объекта
  • distance - расстояние до МКАД/КАД в метрах


Ответ в случае, если адрес не геокодирован

<?xml version="1.0" encoding="UTF-8"?>
<ymaps>
  <error>
    <status>429</status>
    <message>Coordinates aren't found</message>
  </error>
</ymaps>