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

Документация, содержащая описание функциональных характеристик программного обеспечения и информацию, необходимую для установки и эксплуатации программного обеспечения

Программа для ЭВМ “Поиск Дром”

Программа для ЭВМ “Поиск Дром”, далее Программа, предназначена для решения задач, связанных с поиском и размещением объявлений в "Базе данных продажи транспортных средств на портале Drom.ru".

Функциональные характеристики Программы:

• Добавление и редактирование объявлений.
• Поиск объявлений.
• Добавлений фотографий по объявлению.

Информация, необходимая для установки и эксплуатации программного обеспечения

• Доступ к системе осуществляется через http интерфейс. Установка программного обеспечения на ЭВМ пользователя не требуется.
• Минимальные требования для пользователя Программы: cоединение с сетью Интернет со доступной скоростью не менее 1024 кбит/сек.

Пошаговая инструкция для эксплуатации Программы

 

Добавление и редактирование объявлений

Точка входа: https://api.drom.ru/v1.2/bulls/form/{id}
Метод: POST

Описание параметров:

• sign - Идентификатор пользователя (string)
• id - ID объявления (int)
• firmId - ID фирмы автомобиля (int)
• modelId - ID модели автомобиля (int)
• year - Год выпуска автомобиля (int)
• price - Стоимость автомобиля (int)
• cityId - ID города (int)
• regionId - ID региона (int)
• phone1 - Phone1 (string)
• phone2 - Phone2 (string)
• engineVolume - Объем двигателя (float)
• notUsedInRussia - Без пробега по РФ (bool)
• mileageKm - Пробег автомобиля (float)
• currency - ID валюты (int)
• colorId - ID цвета кузова (int)
• info - Описание (string)
• description - Описание (string)
• isNew - Новое авто (bool)
• withoutDocuments - Наличие ПТС (bool)
• noDocsDescription - Описание проблем с документами (string)
• isDamaged - Состояние (bool)
• isGt - Тюнингованное авто (bool)
• wheel - ID расположения руля (int)
• fuelType - ID типа топлива (int)
• transmissionType - ID КПП (int)
• driveType - ID типа привода (int)
• locationType - ID статуса авто (int)
• tradeId - Продавец готов меняться (Битовоя маска) (int)
• tradeInfo - Детали обмена (string)
• frameType - ID типа кузова (int)
• isHybrid - ID типа гибрид (bool)
• isGboExists - Установленно ли ГБО (bool)
• enginePower - Лошадиные силы (int)
• frame - VIN или номер кузова (string)
• vin - VIN или номер кузова (string)
• complectationId - ID комплектации (int)
• generationNumber - Номер поколения (или null) (string)
• restylingNumber - Номер рестайлинга (или null) (string)
• modificationId - ID модификации (или null) (string)

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

curl -k -x localhost:3128 --location --request POST 'https://api.drom.ru/v1.2/bulls/form?sign=c8030ad66ba8021f77ee5d11f6cab37eaedc4812be0ac45fc05a724ad7c24e19u1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'firmId=9' \
--data-urlencode 'modelid=7' \
--data-urlencode 'year=1998' \
--data-urlencode 'cityid=23' \
--data-urlencode 'currency=1' \
--data-urlencode 'wheel=1' \
--data-urlencode 'vin=GJ1-133456709' \
--data-urlencode 'phone1=79994441234' \
--data-urlencode 'info=' \
--data-urlencode 'colorId=3' \
--data-urlencode 'additioninfo=' \
--data-urlencode 'id=' \
--data-urlencode 'price=100000

Поиск объявлений

Точка входа: https://api.drom.ru/v1.2/bulls/search
Метод запроса: GET

Описание параметров:

• firmId - Фирма автомобиля (int)
• modelId - Модель автомобиля (int)
• generationNumber - Номер поколения (int)
• restylingNumber - Номер рестайлинга (int)
• cityId - Город (int)
• regionId - Регион (int)
• minYear - Год выпуска автомобиля (нижняя граница) (int)
• maxYear - Год выпуска автомобиля (верхняя граница) (int)
• minPrice - Стоимость автомобиля (нижняя граница) (int)
• maxPrice - Стоимость автомобиля (верхняя граница) (int)
• minEngineVolume - Объем двигателя (нижняя граница) (float)
• maxEngineVolume - Объем двигателя (верхняя граница) (float)
• minEnginePower - Лошадиные силы (нижняя граница) (int)
• maxEnginePower - Лошадиные силы (верхняя граница) (int)
• minMileageKm - Пробег автомобиля (нижняя граница) (int)
• maxMileageKm - Пробег автомобиля (верхняя граница) (int)
• frameType - Тип кузова (int)
• colorId - Цвет кузова (int)
• transmissionType - Тип КПП (int)
• driveType - Тип привода (int)
• fuelType - Тип топлива (int)
• wheel - Расположение руля (int)
• distance - Дистанция от города (int)
• locationType - Местоположение авто (в наличии, в пути, под заказ) (int)
• isHybrid - Гибрид (bool)
• isGboExists - Установленно ли ГБО (bool)
• isDamaged - Состояние (bool)
• isNew - Новое авто (bool)
• ph - Объявление с фотографией (bool)
• withPhoto - Объявление с фотографией (bool)
• withoutDocuments - Наличие ПТС (bool)
• notUsedInRussia - Без пробега по РФ (bool)
• unsold - Непроданные (bool)
• neighborhood - Ближайшие города (bool)
• orderBy - Поле сортировки (string)
• revertSort - Порядок сортировки: true (desc) - по убыванию; false (asc) - по возрастанию (bool)
• page - Страница (int)

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

curl -k -x localhost:3128 https://api.drom.ru/v1.2/bulls/search?firmId=9

Получение деталей объявления

Точка входа: https://api.drom.ru/v1.3/bulls/{id}
Метод: GET

Описание параметров:

• id - Идентификатор объявления (int)
• mainPhotoWidth - Ширина главной фото (string)

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

curl -k -x localhost:3128 https://api.drom.ru/v1.2/bulls/1

Добавление фотографии

Точка входа: https://api.drom.ru/v1.2/bulls/{id}/photo/add
Метод запроса: POST

Описание параметров:

• sign - Идентификатор пользователя (string)
• id - ID объявления (int)
• isMain - Сделать фото главным (bool)

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

curl -k -x localhost:3128 --location --request POST 'https://api.drom.ru/v1.2/bulls/42392178?sign=c8030ad66ba8021f77ee5d11f6cab37eaedc4812be0ac45fc05a724ad7c24e19u1' --form 'image=@"photo.jpg"'

Удаление фотографии

Точка входа: https://api.drom.ru/v1.2/bulls/{id}/photo/remove
Метод: POST

Описание параметров:

• sign - Идентификатор пользователя (string)
• id - ID объявления (int)
• photoId - ID фото (string)

Изменение главной фотографии

endpoint: https://api.drom.ru/v1.2/bulls/{id}/photo/main
method: POST

Описание параметров:

• sign - Идентификатор пользователя (user_id или boobs) (string)
• id - ID объявления (int)
• photoId - ID фото (string)

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

curl -k -x localhost:3128 --location --request POST 'https://api.drom.ru/v1.2/bulls/1/photo/main?sign=c8030ad66ba8021f77ee5d11f6cab37eaedc4812be0ac45fc05a724ad7c24e19u1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'photoId=9' 

Изменение порядка фотографий

Точка входа: https://api.drom.ru/v1.2/bulls/{id}/photo/reorder
Метод: PUT

Описание параметров:

• sign - Идентификатор пользователя (string)
• id - ID объявления (int)
• photosOrder - ID изображений в нужном порядке (int)

Пример запроса
curl -k -x localhost:3128 --location --request PUT 'https://api.drom.ru/v1.2/bulls/1/photo/reorder?sign=c8030ad66ba8021f77ee5d11f6cab37eaedc4812be0ac45fc05a724ad7c24e19u1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'photosOrder[]=9' --data-urlencode 'photosOrder[]=11'