2D Vehicle Image API

Overview

In today's digital age, personalization is key to enhancing user experience. While our current API provides detailed information about vehicles based on their registration numbers, it lacks a crucial element: the vehicle image. This missing feature limits the user experience and personalization that modern users expect.

To address this, we are introducing a new feature that integrates a comprehensive repository of 2D images of all 4 Wheelers and 2 Wheelers vehicles. This enhancement will enable our API to return the corresponding image of a vehicle based on its Maker, Model, Color, Fuel Type and Year of Manufacturing, offering users a more personalized and engaging experience. This solution not only improves user satisfaction but also aligns with the evolving expectations of our tech-savvy clientele.

The API has the following endpoint:

api/v3/car-api/2Dvehicleimage: This API would help the client to get the 2D image of the vehicle.

API Input and Sample Output

Input cURL

curl --location 'https://api.signzy.app/api/v3/2Dvehicleimage' \
--header 'Content-Type: application/json' \
--header 'Authorization:' \
--data '
{
    "brand": "",
    "model": "",
    "yearOfManufacturing": "",
    "color": "",
    "fuelType": "",
    "cubicCapacity": ""
}
'

Input Table

Parameters	Required	Type
brand	Yes	String
model	Yes	String
yearOfManufacturing	Optional	String
color	Optional	String
fuelType	Optional	String
cubicCapacity	Optional	String

Output cURL

{
    "result": {
        "brand": "",
        "model": "",
        "yearOfManufacturing": "",
        "color": "",
        "fuelType": "",
        "cubicCapacity": "",
        "image": "",
        "matchScore":""
    }
}

Output Table

Parameter	Type	Description
Brand	String	The manufacturer or brand of the vehicle.
Model	String	The specific model name of the vehicle.
Year of Manufacturing	String	The year when the vehicle was manufactured.
Color	String	The color of the vehicle.
Fuel Type	String	The type of fuel the vehicle uses (e.g., petrol, diesel, electric).
Cubic Capacity	String	The engine's cubic capacity, indicating the volume of its cylinders.
Image Persist Link	String	A URL or link to access the stored image of the vehicle.
Match Score	Float	A score indicating the accuracy or confidence level of the vehicle image matching the details.

Status Codes

Status Code	Status	Description
200	Success	The data was successfully returned
400	Invalid Input Data	The input Vehicle number is invalid
404	Detail not found	Image detail not found
409	Upstream Error	Error in fetching data from upstream
500	Internal Server Error	Something is broken. This is usually a temporary error, for example in a high-load situation.or if an endpoint is temporarily having issues. Try again later.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].