Документация API
Авторизация
API использует HTTP Bearer Authentication.
Рекомендуемый способ — передавать API-ключ в HTTP-заголовке авторизации:
Authorization: Bearer <API-key>Также поддерживается альтернативный способ — передача ключа в GET-параметре запроса:
?key=<API-key>Использование GET-параметра допускается для простых интеграций и тестирования, однако для production-систем рекомендуется использовать HTTP-заголовок авторизации.
Если ключ не верный — запрос вернёт заголовок "401 Unauthorized".
Если ключ истёк или превышен лимит trial-запросов — API вернёт "429 API key expired" или "429 Trial request limit reached".
Расчёт маршрута
Endpoint:
GET /v1/route
Пример запроса по названиям городов:
https://api.avtodispetcher.ru/v1/route?from=Уфа&to=Казань
Пример запроса по координатам (формат: широта,долгота):
https://api.avtodispetcher.ru/v1/route?from=54.726288000%2C55.947727000&to=55.782354700%2C49.124226600
Пример PHP-скрипта (укажите в коде свой API-ключ).
Параметры запроса:
- from — начальная точка маршрута: город или координаты широта,долгота. Обязательный параметр.
- to — конечная точка маршрута: город или координаты. Обязательный параметр.
- v — промежуточные точки маршрута, перечисляются через точку с запятой ";".
Подсказки городов (autocomplete)
Endpoint:
GET /v1/cities
Запрос можно выполнять без заголовка авторизации
Пример запроса:
https://api.avtodispetcher.ru/v1/cities?q=Ростов&limit=5&onlyCountries[]=RU
Пример ответа (JSON). Демонстрационный пример.
Параметры запроса:
- q — поисковый запрос (минимум 2 символа). Обязательный параметр.
- limit — максимальное количество подсказок (по умолчанию 10).
- onlyCountries — массив ISO-кодов стран для ограничения поиска (по умолчанию без ограничений).
Особенности: поддерживается автоматическая коррекция раскладки клавиатуры и дополнение городов-тёзок регионом/страной.
Геокодер
Endpoint:
GET /v1/geocode
Пример запроса:
https://api.avtodispetcher.ru/v1/geocode?q=Воронеж
Браузерные запросы и CORS
Для работы кроссдоменных AJAX-запросов из браузера добавьте домены, на которых будет работать ваш проект в секцию "Разрешенные домены (CORS)" в личном кабинете API.
Пример интеграции
Пошаговое руководство: калькулятор междугороднего такси на Tilda
Нужна помощь с интеграцией?
Можно написать напрямую разработчику API - Илье Гуку.
Обсудим задачу, подскажу по запросам и подводным камням интеграции. Кратко опишите проект и где планируете использовать API. Обычно отвечаю в рабочие дни в течение дня.
Telegram: @ilyaguk Email: support@avtodispetcher.ru Форма обратной связи: здесь