Documentation

 

Architecture and Concepts


The VINquery.com web services exposes via representational state transfer (REST) for client applications to access a suite of VIN decoding, machine learning and object recognition algorithms. One distinguishing characteristic of the REST architecture is that communications between a client and a server are stateless. Requests are initiated by the client, the server processes the request, returns a response, and the entire transaction is considered atomic. This documentation provides the technical description of the real-time web services provided by VINquery.com.


To maintain reliability and stability within our demo and production environments, VINquery.com operates with certain API call efficiency guidelines. To ensure effective load balance we continually monitor the API calls to our backend systems and we will contact developers that are putting unnecessary burden on the system. Applications are not allowed to poll for service status more than once every 15 minutes.

 

Resources

There are two types of resources associated with these services: images and 17-character text string(reprenting a VIN). Uploaded images can be any MIME type, such as JP(E)G, PNG, BMP, GIF. The object recognition algorithms currently work on 32-bit/24-bit/8-bit grayscale images, so images are converted to 32-bit/24-bit/8-bit grayscale before being submitted to the recognition engines.

RESTful APIs

All requests are sent using HTTP GET or HTTP POST methods, and all responses are in XML format.

REST API HTTP Type Base URL
VINdecoding Web Service GET http://ws.vinquery.com/restxml.aspx
VINfix Web Service GET http://www.recognition.ws/vinfix/v1
VINocr Web Service POST http://www.recognition.ws/vinocr/v1
VINbarcode Web Service POST http://www.recognition.ws/vinbarcode/v1
VINqrcode Web Service POST http://www.recognition.ws/vinqrcode/v1
LPR Web Service POST http://www.recognition.ws/lpr/v1

HTTP Staus Codes

All VINquery.com web services return the following HTTP status codes:

HTTP Status Code Description
200 Success Request
400 Bad Request
500 Internal Server Error