Доступ к API

АвтоЛидер API (от англ. application programming interface – интерфейс программирования приложений) — это интерфейс, который позволяет получать доступ к web-сервисам компании посредством HTTP-запросов.

Авторизация

Каждый запрос к API должен сопровождаться параметром access-token.
Для получения access-token нужно связаться с вашим менеджером, после чего вы сможете увидеть ваш access-token в разделе Настройки личного кабинета.

Если вы уже зарегистрировались на сайте, то сообщите свой email вашему менеджеру при запросе access-token.
Если вы еще не зарегистрированы на сайте, то менеджер создаст вам учетную запись, с помощью которой вы сможете заходить в личный кабинет.

Основы

Базовый URL для запросов: https://{city}.autoleader1.ru/api/v1/, где {city} - код вашего города регистрации, например ulanude.
Аргументы могут передаваться как GET или POST параметры, в зависимости от типа запроса. Используется кодировка UTF-8.

Все ответы представляют собой JSON-объект. Его общая структура выглядит следующим образом:

{
    "code": ...
    "data": ...
    "error": ...
}

code - код ошибки. При успешном выполнении запроса код ошибки равняется 0.
error - название ошибки. Равно null при успешном выполнении запроса.
data - основное содержимое ответа. При неуспешном выполнении запроса в этом поле будет более подробное описание ошибки.

Пример неуспешного запроса (при неверном значении access-token):

{
    "code": -1,
    "data": "Your request was made with invalid credentials.",
    "error": "Unauthorized"
}

Примеры успешных запросов приведены в описаниях соответствующих методов API.

Пагинация

Методы, возвращающие большое количество объектов (более 50), используют пагинацию (например метод получения списка заказов и метод получения списка профилей доставки).
В этих методах добавляются дополнительные атрибуты _links и _meta.
Используя значение вложенного атрибута page_count, можно перебрать все страницы, дописывая к исходному URL в конце &page={page},
подставляя вместо {page} номер очередной страницы пагинатора, не превышающей значения атрибута page_count

{
    "code": 0,
    "data": [
        ...
    ],
    "_links": {
        "self": {
            "href": "https://{city}.autoleader1.ru/api/v1/sale/listing/?access-token={access-token}&page=1"
        },
        "next": {
            "href": "https://{city}.autoleader1.ru/api/v1/sale/listing/?access-token={access-token}&page=2"
        },
        "last": {
            "href": "https://{city}.autoleader1.ru/api/v1/sale/listing/?access-token={access-token}&page=8"
        }
    },
    "_meta": {
        "count": 390,
        "page_count": 8,
        "page_num": 1,
        "per_page": 50
    },
    "error": null
}

Методы API

Все указанные ниже URL дописываются к базовому URL для API.

Метод	URL	Описание
GET	/profile/?access-token={access-token}	Информация о профиле
GET	/search/?access-token={access-token}&article={article}&brand_name={brand-name}	Поиск запчастей
POST	/sale/?access-token={access-token}	Создание заказа
GET	/sale/listing/?access-token={access-token}	Список заказов
GET	/sale/?access-token={access-token}&id={id}	Информация о заказе
GET	/sale-profile/listing/?access-token={access-token}	Список профилей доставки
GET	/sale-profile/?access-token={access-token}&id={id}	Информация о профиле доставки

Ограничения на использование API

Максимально допустимое количество обращений к API - 60 в минуту. При превышении этого лимита запросы не принимаются. При значительном превышении лимита ваш access-token может быть автоматически заблокирован. Если ваш access-token заблокировали, либо если вам нужно отправлять более 60 запросов к API в минуту - обратитесь к вашему менеджеру.

API для разработчиков