Предоставление данных об адресах поездки

При расчете поездки есть возможность передать адрес в нескольких форматах:

1. Наименование адреса / адрес строкой
2. Координаты
3. Описанием объекта адреса
4. Идентификатор внутреннего справочника адресов

Адрес строкой

В случае передачи адреса строкой, будет выполнено геокодирование, для получения координат адреса

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

{
  "value": "г. Москва, ул. Пример, дом 4",
  "type": "Address"
}

Координаты

В случае передачи адреса строкой, будет выполнено обратное геокодирование, для получения наименования адреса

Координаты передаются в формате lat,lng

Этот метод тоже не обладает 100% точностью, тк иногда провайдеры геокодинга возращают объект с немного другими координатами.

{
  "value": "35.26,52.44",
  "type": "Coodrinates"
}

Объект адреса

{
  "value": {
    "address": "г. Москва, ул. Пример, дом 4",
    "lat": 35.26,
    "lat": 52.44
  },
  "type": "Object"
}

Идентификатор внутреннего справочника адресов

{
  "value": "d15411e4-5eba-4fd1-9b73-bef059657bd0-1",
  "type": "SearchId"
}

Запрос к справочнику адресов осуществляется вызовом метода /api/v1.1/addresses

Пример запрос адреса г. Москва, ул. Пример, дом 4:

curl \
 -X GET \
 -H "x-api-key: your_api_key" \
 https://api.rustransfer.org/public/transfers-api/api/v1.1/addresses?query=%D0%B3.%20%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0,%20%D1%83%D0%BB.%20%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80,%20%D0%B4%D0%BE%D0%BC%204

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

{
  "items": [
    {
      "id": "d15411e4-5eba-4fd1-9b73-bef059657bd0-1",
      "name": "г. Москва, ул. Пример, дом 4"
    },
    {
      "id": "d15411e4-5eba-4fd1-9b73-bef059657bd0-2",
      "name": "г. Москва, ул. Пример, дом 4а"
    }
  ]
}