Page tree
Skip to end of metadata
Go to start of metadata


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

Авторизация

Сервис предоставляет REST API. Для использования методов API необходимо сперва пройти авторизацию в сервисе авторизации по клиентскому ключу Pony Express. В случае, если ключ действующий, клиенту вернется Bearer Token со временем жизни 24 часа, который необходимо передавать в каждом запросе к сервису автодополнения адресов. Пример вызова сервиса можно посмотреть в Postman-коллекции Получение_токена_авторизации.postman_collection.json.

Методы сервиса автодополнения

Примеры всех нижеописанных методов указаны в Postman-коллекции  Autocomplete addresses.postman_collection.json.


API сервиса автодополнения представляет следующие методы:

HTTP GET https://autocomplete.ponyexpress.ru/api/autocomplete/locality (Подсказки города)

Параметры, необходимые передать: 

countryCode=RUS - код страны, по которой ищутся подсказки (доступное значение только RUS)

context=Россия - контекст поиска подсказки (для метода locality значение параметра context всегда равно "Россия")

prefix=Ниж - префикс, набранный пользователем.

В ответе: список предполагаемых городов



HTTP GET https://autocomplete.ponyexpress.ru/api/autocomplete/street (Подсказки улицы)

Параметры, необходимые передать: 

countryCode=RUS - код страны, по которой ищутся подсказки (доступное значение только RUS)

context=Москва - контекст поиска подсказки (для метода street значение параметра context равно имени города, по которому осуществляются подсказки)

prefix=Твер- префикс, набранный пользователем

В ответе: Список предполагаемых улиц


HTTP GET https://autocomplete.ponyexpress.ru/api/autocomplete/building (Подсказки дома)

Параметры, необходимые передать: 

countryCode=RUS - код страны, по которой ищутся подсказки (доступное значение только RUS)

context=Москва,Маршала Жукова пр-кт - контекст поиска подсказки (для метода building значение параметра context складывается из имени города и улицы, указанных через запятую без пробелов, например "Москва,Маршала Жукова пр-кт")

prefix=7 - префикс, набранный пользователем

В ответе: Список предполагаемых домов


HTTP GET https://autocomplete.ponyexpress.ru/api/autocomplete/postcode (Выдача почтового индекса для указанного дома)

Параметры, необходимые передать: 

countryCode=RUS - код страны, по которой ищутся подсказки (доступное значение только RUS)

context=Москва,Маршала Жукова пр-кт - контекст поиска почтового индекса (для метода postcode значение параметра context складывается из имени города и улицы, указанных через запятую без пробелов, например "Москва,Маршала Жукова пр-кт")

buildingNumber=7 - номер дома, для которого необходимо определить индекс


  • No labels