Введение в API
API cледует модели RESTfull, для вызова нужен ключ API, который можно сгенерировать после покупки баз на странице их скачивания.
Информация, получаемая через API более актуальная, чем полученная через апдейты и может меняться чаще. В любом случае, для
ориентирования по актуальности данных (кеширование и прочее) стоит ориентироваться на выпускаемые апдейты.
Актуальная версия API: 1
URL для вызова
Все вызовы идут по следующим адресам:
http://tyresaddict.ru/api/... - для общих вызовов
http://tyresaddict.ru/api/supplier/... - для сервиса Подключение поставщиков
http://tyresaddict.ru/api/tyres/... - для вызовов к базе шин
API разделены по сервисам и базам для удобства управления, версионности и разделения по продуктам. На текущий момент это
supplier - API сервиса Подключение поставщиков, API будет работать при покупке любой базы
tyres - тип ключей и API базы шин (работает при покупке либо комплекта либо базы шин)
uni - тип ключа под комплект баз, на все виды API
Для вызовов кроме /info нужны два обязательных параметра: api_version - версия API у клиента (будем стараться поддерживать старые версии) api_key - ключ API
Возвращаемые данныеAPI всегда возвращает json. Обязательное поле result true\false результат вызова, при false будет возвращен также message с описанием
Документация в разных форматах
У нас есть несколько форматов этой документации. Один на этом сайте, на этой странице, второй, в формате OpenAPI. Ниже приведены отдельные ссылки на всю документацию.
Документация сайта
Документация по API базы шин
Документация по API базы подбора по авто
Документация OpenAPI/Swagger (beta!)
Документация по API базы шин / OpenAPI
Документация по API базы подбора по авто / OpenAPI
Общие методы
GET /[supplier|tyres|fitment]/info
- получение общей информации, версиям, ключу, если он передан
параметры
может вызываться даже без обязательных параметров, при вызове с ключом API возвращает также информацию о ключе
вызвать прямо со страницы
ответ
api_type - тип api api_version - версия api на сервере. при изменении и расхождении версии на клиенте
GET /[supplier|tyres|fitment]/updates - получение дат последних апдейтов базы параметры нет ответ
API Сервиса подключения поставщиков
POST /supplier/process_csv
- обработка csv поставщиков также как в сервисе на сайте
параметры
csv - csv текстом в формате сервиса (см документацию сервиса)
ответ
csv - csv, результат обработки, текстом в формате сервиса (см документацию сервиса)
offers_count - обработанных позиций\строк прайс-листа
found_offers_count - позиций\строк прайс-листа, совмещенных с нашими базами
POST /supplier/process_csv_utf8
- обработка csv поставщиков, но текст и вывод строго в кодировке UTF-8
параметры
csv - csv текстом в формате сервиса (см документацию сервиса)
ответ
csv - csv, результат обработки, текстом в формате сервиса (см документацию сервиса)
offers_count - обработанных позиций\строк прайс-листа
found_offers_count - позиций\строк прайс-листа, совмещенных с нашими базами
Tyre API / База шин
GET /tyres/vendors - получение полного списка производителей шин параметры no ответ
GET /tyres/find_vendor_by_name - поиск производителя шин по названию параметры vendor_name - название производителя шин ответ
V1GET /tyres/find_vendor_by_id
V1,V2 GET /tyres/vendor
- информация о производителе шин по vendor_id
параметры
vendor_id - id производителя шин ответ
GET /tyres/vendor_models - получение списка моделей производителя шин параметры vendor_id - id производителя шин ответ
GET /tyres/model
- информация о модели шин по model_id
параметры
model_id - tyre model id ответ
Некоторые поля, обратите внимание:
photo_catalog -
(beta) пример отдачи фото (квадрат 180x180px) для каталога, путь для локального хранилища, без домена
cdn_photo_catalog -
(beta) пример отдачи фото (square 180x180px) для каталога с нашего cdn. для использования его в вашем продакшне пишите
GET /tyres/model_specs - информация о размерах и спецификации шин конкретной модели по model_id параметры model_id - tyre model id ответ
API Базы подбора по авто
В разработке, пишите нам - ускорим
GET /fitment/makes - получение полного списка производителей авто параметры exclude_local - (optional) 'true' для получения списка без локальных производителей ответ
GET /fitment/make - информация о производителе авто по make_id параметры make_id - make_id производителя авто ответ
GET /fitment/series - информация о линейках авто по make_id параметры make_id - make_id производителя авто ответ
GET /fitment/models - информация о моделях авто по make_id параметры make_id - make_id производителя авто ответ
GET /fitment/model_years - годы производства конкретной модели по model_id параметры model_id - model_id модели авто ответ
GET /fitment/model_modifications - модицикации модели по model_id конкретного года параметры model_id - model_id модели авто year - год производства ответ
GET /fitment/fitment - информация о размерах колес по model_id, конкретного года и mod_id модификации параметры model_id - model_id модели авто year - год производства mod_id - mod_id модификации ответ
GET /fitment/finder_specs - информация для поиска, спецификации для дисков и шин параметры no ответ width, r (diameter), bolt patetrns (wheel pcd), dia (center diameter of wheel)
