About AutoSights.com API


  AutoSights.com API is currently running in beta mode. Please report error occurred while using the API.

AutoSights.com's API has design to attend the auto-industry need for a stable and practical application programming interface system which offers media and services required for the operation of dealership websites.

The content available on this API is modeled based on REST with use of Bearer tokens and, is currently on its beta release.

API packages

API packages are predefined group of rules which defines who you may use the API. For instance, a package may allow for 1000 requests while, other package types may offer extended requests and other benefits.

While in beta release, only one type of package is offer, completely free of cost.

About REST APIs

In a nutshell, REST APIs (which are a type of web API) involve requests and responses, not too unlike visiting a web page. You make a request to a resource stored on a server, and the server responds with the requested information. The protocol used to transport the data is HTTP. “REST” stands for Representational State Transfer.

Resource description

“Resources” refers to the information returned by the API.

Endpoints and methods

The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
The same resource usually has a variety of related endpoints, each with different paths and methods but returning different information about the same resource. Endpoints usually have brief descriptions similar to the overall resource description but shorter. Also, the endpoint shows the end path of a resource URL only, not the base path common to all endpoints.

Parameters

Parameters are options you can pass with the endpoint (such as specifying the response format or the amount returned) to influence the response. There are several types of parameters: header parameters, path parameters, and query string parameters. Request bodies are closely similar to parameters but are not technically a parameter.
The different types of parameters are often documented in separate groups on the same page. Not all endpoints contain each type of parameter.

Change Logs


  Change logs will be available once the API status changes from beta to production.