Сервисы для автосайтов

Документация к API баз данных

Введение в 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 нужны два обязательных параметра: version - версия 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 на сервере. при изменении и расхождении версии на клиенте

{"result":true,"api_type":"tyres","api_version":1}

GET /[supplier|tyres|fitment]/updates - получение дат последних апдейтов базы параметры нет ответ

{"db_tyres":"2020-01-27","db_wheels":"2020-01-18","db_vehicle":"2020-01-27","result":true}

API Сервиса подключения поставщиков

POST /supplier/process_csv - обработка csv поставщиков также как в сервисе на сайте
параметры csv - csv текстом в формате сервиса (см документацию сервиса) ответ csv - csv, результат обработки, текстом в формате сервиса (см документацию сервиса) offers_count - обработанных позиций\строк прайс-листа found_offers_count - позиций\строк прайс-листа, совмещенных с нашими базами

{"result":true,"csv":"1313;8;880;Kumho;Ice Power KW21\nT354;17;494;Hankook;Radial DW04\n","offers_count":12,"found_offers_count":10}

POST /supplier/process_csv_utf8 - обработка csv поставщиков, но текст и вывод строго в кодировке UTF-8
параметры csv - csv текстом в формате сервиса (см документацию сервиса) ответ csv - csv, результат обработки, текстом в формате сервиса (см документацию сервиса) offers_count - обработанных позиций\строк прайс-листа found_offers_count - позиций\строк прайс-листа, совмещенных с нашими базами

{"result":true,"csv":"1313;8;880;Kumho;Ice Power KW21\nT354;17;494;Hankook;Radial DW04\n","offers_count":12,"found_offers_count":10}

Tyre API / База шин

GET /tyres/vendors - получение полного списка производителей шин параметры no ответ

{"result":true,"vendors":[{"vendor_id":"13","vendor_name":"Accelera","vendor_url":"accelera"},{"vendor_id":"56",...

GET /tyres/find_vendor_by_name - поиск производителя шин по названию параметры vendor_name - название производителя шин ответ

{"result":true,"vendor":{"vendor_id":"1","vendor_name":"Michelin","vendor_url":"michelin"}}

V1GET /tyres/find_vendor_by_id
V1,V2 GET /tyres/vendor - информация о производителе шин по vendor_id параметры vendor_id - id производителя шин ответ

{"result":true,"vendor":{"vendor_id":"1","vendor_name":"Michelin","vendor_url":"michelin"}}

GET /tyres/vendor_models - получение списка моделей производителя шин параметры vendor_id - id производителя шин ответ

{"result":true,"models":[{"model_id":"1252","model_name":"4x4 A/T XTT","model_url":"4x4_at_xtt","auto_id":"2","season_id":"3"},{"model_id":"240",

GET /tyres/model - информация о модели шин по model_id параметры model_id - tyre model id ответ Некоторые поля, обратите внимание:
photo_catalog - (beta) пример отдачи фото (квадрат 180x180px) для каталога, путь для локального хранилища, без домена
cdn_photo_catalog - (beta) пример отдачи фото (square 180x180px) для каталога с нашего cdn. для использования его в вашем продакшне пишите

{"result":true,"model":{"model_id":"123","model_name":"Pilot Exalto","model_url":"pilot_exalto","model_year":"2009","car_type":"1","car_type_str":"passenger","season":"summer",...

GET /tyres/model_specs - информация о размерах и спецификации шин конкретной модели по model_id параметры model_id - tyre model id ответ

{"result":true,"sizes":{"sizes":[{"width":"205","profile":"55","rim":"16","load_index":"91","speed_rating":"Y","runflat_flag":"off","xl_flag":"off","c_flag":"off"},{"width":"195","profile":"50",...

API Базы подбора по авто

В разработке, пишите нам - ускорим

GET /fitment/makes - получение полного списка производителей авто параметры exclude_local - (optional) 'true' для получения списка без локальных производителей ответ

{"result":true,"makes":[{"make_id":"22","make_name":"Acura","make_url":"acura"},{"make_id...

GET /fitment/make - информация о производителе авто по make_id параметры make_id - make_id производителя авто ответ

{"result":true,"make":{"make_id":"1","make_name":"Alfa Romeo","make_url":"alfa_romeo"}}

GET /fitment/series - информация о линейках авто по make_id параметры make_id - make_id производителя авто ответ

{"result":true,"series":[{"model_seria":"CL"},{"model_seria":"EL"},{"model_seria":"ILX"},{"model_seria...

GET /fitment/models - информация о моделях авто по make_id параметры make_id - make_id производителя авто ответ

{"result":true,"models":[{"model_id":"18","model_seria":"CL","model_name":"CL","model_url":"cl","model_start_year":"1998","model_end_year":"2001"},{"model_id":"1589","model_seri...

GET /fitment/model_years - годы производства конкретной модели по model_id параметры model_id - model_id модели авто ответ

{"result":true,"years":[1998,1999,2000,2001]}

GET /fitment/model_modifications - модицикации модели по model_id конкретного года параметры model_id - model_id модели авто year - год производства ответ

{"result":true,"years":[{"mod_id":"6","mod_name":"2.3 i"},{"mod_id":"7","mod_name":"3.0 i"}]}

GET /fitment/fitment - информация о размерах колес по model_id, конкретного года и mod_id модификации параметры model_id - model_id модели авто year - год производства mod_id - mod_id модификации ответ

{"result":true,"fitment":{"wheel_params":{"param_id":"5","dia":"67.1","nut":"12x1.5","bolt":"0x0","pcd":"4x114.3","pcd_first":"4","pcd_second":"114.3"},"wheels":{"factory":...

GET /fitment/finder_specs - информация для поиска, спецификации для дисков и шин параметры no ответ width, r (diameter), bolt patetrns (wheel pcd), dia (center diameter of wheel)

{"result":true, "width":["3.5","4","4.5","5","5.5","6","6.5","7","7.5","8","8.5","9","9.5","10","10.5","11","11.5"],"r":["12","13",...