Перейти к основному содержимому

Введение

Назначение

Продукт Veeroute - набор сервисов для решения логистических задач.

Для каждого типа задач и бизнес отрасли существует отдельный интерфейс планирования со своей собственной структурой данных.

Все сервисы имеют описание API согласно спецификации OpenAPI 3.0.3.

Версионирование

Каждый сервис имеет собственную версию API.

Версия API состоит из трех целых чисел - major.minor.build.

Соответствующая версия увеличивается в случаях:

  • major - обновление API получает несовместимые с предыдущими версиями изменения
  • minor - появляется новая функциональность и обновление имеет обратную совместимость в рамках мажорной версии (в зависимости от генератора и языка программирования - обновление минорной версии может не иметь обратную совместимость с библиотеками, которые были созданы на предыдущей версии)
  • build - обновление документации, примеров, исправление ошибок

Мажорная версия указывается в адресе сервера: api.edge.veeroute.tech/v4/account.

danger

Если в адресе не указывать версию - то используется последняя актуальная версия. Актуальные версии указаны на страницах с описанием сервиса.

Авторизация

Все сервисы имеют единый механизм авторизации и аутентификации - по токену (Bearer Authentication), который необходимо указывать при каждом запросе.

Для каждого пользовательского аккаунта создается уникальная пара логин-пароль, которые необходимы для получения токена через Account API.

Для получения аккаунта просьба обратиться в нашу команду технической поддержки.

danger

При смене пароля пользователя все созданные ранее токены становятся недействительными.

Инструменты

Для данного формата существует большое количество готовых инструментов для генерации клиентских приложений и интеграции.

Рекомендуемые генераторы - OpenApi Generator и Swagger Codegen.