Документация API

 

Для работы с API используется HTTP-протокол. Информацию о ходе разработки можно получить на нашем форуме.

Доступные версии API

  • v1.0
  • v1.2 (находится в разработке)

Необходимые заголовки запроса

  • Accept - значение MIME-типа «application/json».
  • Content-Type - значение MIME-типа «application/json».
  • Authorization: Bearer <acсess_token>.

Sandbox версия

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

Адрес для запросов: http://sandbox-api.ati.su/<необходимый ресурс>

Для тестирования работы с API воспользуйтесь тестовым сервером: http://sandbox-web.ati.su/. На тестовом сервере отключена часть функций и ограничены аппаратные ресурсы. Возможны краткосрочные периоды недоступности сервера во время выкладки обновленных версий.

Пользователь на тестовом сервере создается автоматически сразу после первого обращения к API с помощью токена, полученного с id.ati.su. Далее для входа в кабинет необходимо использовать следующие логин/пароль: l<id_пользователя> / l<id_пользователя>. Например: l123123 / l123123.

Пример запроса

GET /loads HTTP/1.1
Host: sandbox-api.ati.su
Accept: application/json
Content-Type: application/json
Authorization: Bearer d76421685345678948fe4d1511e08892e

Production версия

Адрес для запросов с указанием версии: http://api.ati.su/v<версия>/<необходимый ресурс> , например: http://api.ati.su/v1.0/loads

Адрес для запросов с последней доступной версией: http://api.ati.su/<необходимый ресурс> , например: http://api.ati.su/loads

Пример запроса

GET /loads HTTP/1.1
Host: api.ati.su
Accept: application/json
Content-Type: application/json
Authorization: Bearer d76421685345678948fe4d1511e08892e

Как получить access_token

Для облачных сервисов и программ для ПК

  1. Отправьте письмо на api@ati.su с запросом доступа к API и получите токен (client_id) для каждого программного продукта. 
  2. Сформируйте URL следующим образом: http://id.ati.su/apps/<client_id> (<client_id> - полученный токен), например: http://id.ati.su/apps/5edb665b3c6bc732edbe87d58aeb3ef3ba74f593
  3. Предоставьте данный URL клиенту, чтобы клиент разрешил для ПО доступ к своим данным. Для этого клиент:
    • В браузере переходит по предоставленному URL. При необходимости авторизуется на сайте ati.su, используя свои логин и пароль.
    • В списке сторонних приложений выбирает приложение интегратора и копирует в буфер обмена access_token.

    • Переходит в приложение интегратора и вставляет access_token из буфера обмена.

      4. Используйте полученный access_token клиента для отправки запросов к API.

Для мобильных приложений (по протоколу oauth2)

  1. Отправьте письмо на api@ati.su с запросом доступа к API и укажите redirect_uri (например, myapp://oauthresponse). По redirect_uri мы будем возвращать данные после того, как клиент авторизуется на ati.su. Получите токен (client_id) для каждого программного продукта.
  2. Сформируйте URL вида: https://id.ati.su/oauth/?client_id=<client_id> (<client_id> - полученный токен), например: https://id.ati.su/oauth/?client_id=5edb665b3c6bc732edbe87d58aeb3ef3ba74f911
  3. Предоставьте данный URL клиенту, чтобы клиент разрешил для ПО доступ к своим данным. Для этого клиент на мобильном устройстве:
    • В браузере переходит по предоставленному URL. При необходимости авторизуется на сайте ati.su, используя свои логин и пароль.
    • Разрешает приложению доступ к своим данным в АвтоТрансИнфо.

      4. После этого клиента перенаправят на redirect_uri с параметром aсcess_token=<aсcess_token>.

Подробная информация о кодах ошибок в API

Для описания ошибок не всегда достаточно HTTP кода ответа. При возникновении ошибки в API в теле ответа возвращается объект, описывающий ошибку.

Подробнее