REST API базы данных
транспортных средств Basebuy.ru

Адрес запроса

Для вызва метода Basebuy.API, необходимо сделать GET-запрос по HTTPS на адрес:

https://api.basebuy.ru/api/auto/v1/entityName.actionName.format?api_key=[api_key]&id_type=[id_type]

entityName — запрашиваемая сущность:
  • type — тип транспортного средства
  • mark — марки
  • model — модели
  • serie — серии
  • generation — поколения
  • modification — модификации
  • characteristic — характеристики
  • characteristicValue — значения характеристик
  • equipment — комплектации
  • option — опции
  • optionValue — значения опций
actionName — действие:
  • getAll — получение всех экземпляров сущности;
  • getDateUpdate — получение даты последнего обновления данных;
format — выходной формат данных:
  • csv — для действия getAll пока только CSV (первая строка - заголовки колонок, затем данные разделённые запятыми, значения в кавычках);
  • timestamp — для действия getDateUpdate возвращается число в формате Unix timestamp;
  • string — для действия getDateUpdate возвращается строка в формате "d.m.Y H:i:s" (01.01.2016 00:01:59);
params — параметры запроса:
  • api_key — API ключ (токен), полученный для работы (запрос на );
  • id_type — идентификатор типа транспортного средства (как получить список идентификаторов), обязателен почти для всех запросов;

Возможные варианты запросов

Для проверки работы API, отправляйте запросы из веб-интерфейса. Описаны параметры запроса каждой функции и формат возвращаемых данных.

type

GET
/api/auto/v1/type.getAll.csv
Получить все Типы транспортных средств
GET
/api/auto/v1/type.getDateUpdate.timestamp
Получить дату обновления Типов транспортных средств

mark

GET
/api/auto/v1/mark.getAll.csv?id_type=1
Получить все Марки Легковых автомобилей
GET
/api/auto/v1/mark.getDateUpdate.timestamp?id_type=2
Получить дату обновления Марок Грузовых автомобилей

model

GET
/api/auto/v1/model.getAll.csv?id_type=1
Получить все Модели Легковых автомобилей
GET
/api/auto/v1/model.getDateUpdate.timestamp?id_type=2
Получить дату обновления Моделей Грузовых автомобилей

generation

GET
/api/auto/v1/generation.getAll.csv?id_type=1
Получить все Поколения Легковых автомобилей
GET
/api/auto/v1/generation.getDateUpdate.timestamp?id_type=1
Получить дату обновления Поколений Легковых автомобилей

serie

GET
/api/auto/v1/serie.getAll.csv?id_type=1
Получить все Серии Легковых автомобилей
GET
/api/auto/v1/serie.getDateUpdate.timestamp?id_type=2
Получить дату обновления Серий Грузовых автомобилей

modification

GET
/api/auto/v1/modification.getAll.csv?id_type=1
Получить все Модификации Легковых автомобилей
GET
/api/auto/v1/modification.getDateUpdate.timestamp?id_type=2
Получить дату обновления Модификаций Грузовых автомобилей

characteristic

GET
/api/auto/v1/characteristic.getAll.csv?id_type=1
Получить все Характеристики Легковых автомобилей
GET
/api/auto/v1/characteristic.getDateUpdate.timestamp?id_type=2
Получить дату обновления Характеристик Грузовых автомобилей

characteristicValue

GET
/api/auto/v1/characteristicValue.getAll.csv?id_type=1
Получить все Значения характеристик Легковых автомобилей
GET
/api/auto/v1/characteristicValue.getDateUpdate.timestamp?id_type=2
Получить дату обновления Значений характеристик Грузовых автомобилей

equipment

GET
/api/auto/v1/equipment.getAll.csv?id_type=1
Получить все Комплектации Легковых автомобилей
GET
/api/auto/v1/equipment.getDateUpdate.timestamp?id_type=1
Получить дату обновления Комплектации Легковых автомобилей

option

GET
/api/auto/v1/option.getAll.csv?id_type=1
Получить все Опции Легковых автомобилей
GET
/api/auto/v1/option.getDateUpdate.timestamp?id_type=1
Получить дату обновления Опций Легковых автомобилей

optionValue

GET
/api/auto/v1/optionValue.getAll.csv?id_type=1
Получить все Значения опций Легковых автомобилей
GET
/api/auto/v1/optionValue.getDateUpdate.timestamp?id_type=1
Получить дату обновления Значений опций Легковых автомобилей

Коды ошибок

Необходимо предусмотреть, что в результате запроса могут возникникать ошибоки. Они возвращаются в виде соответствующих кодов HTTP-запроса.

401 — API ключ неверный или просрочен

Указан неверный API-ключ или срок действия вашего ключа закончился. Обратитесь в службу поддержки по адресу

404 — страница не найдена

По заданным параметрам запроса невозможно построить результат. Проверьте наличие параметра id_type, который обязателен для всех сущностей, кроме собственно type.

500 — ошибка сервера

Временные перебои в работе сервиса.

501 — запрошенный метод не существует

Запрошено несуществующее действие для указанной сущности.

503 — обновление данных

Временное прекращение работы сервиса в связи с обновлением базы данных.

509 — превышен лимит обращений к API

Превышено максимальное количество обращений к API за последние 24 часа. Подождите.

200 — запрос выполнен успешно

Готовый пример работы с Auto API на PHP

BaseBuy.API SDK PHP

https://github.com/basebuy/basebuy-auto-sdk-php