Skip to main content

NetLook Vehicle Record (NVR) API

Comments

1 comment

  • Adam Frantz

    To get started with the NVR -  API  you can get a lot of information from our online guide here:

    http://api.netlook.com/api/

     

    The above questions were asked by a new partner looking to integrate and are a great set of questions.   

     

    1)  The documentation does cover how NetLook handles error cases for the most common scenarios under each different type of request.   

    • If you are making a READ request the most likely error scenario is that we were unable to find the vehicle being queried.   The resulting JSON response from our api would look like this:

      HTTP
      /1.1 200 OK { "success" : false, "error" : { "id" : 9300, "code" : "VehicleNotFound", "message" : "Vehicle not found." } }

      The "success" indicator comes back with a "false" value and the error message contains an error ID value and also has a detailed message that indicates that the vehicle could not be found. 

    • If you were to make a request to a function that you did not have permission to access this would be the resulting JSON response:

      HTTP/1.1 200 OK { "success" : false, "error" : { "id" : 9980, "code" : "NoAccess", "message" : "No Access" } }

      Again, the "success" indicator returns false and the "error" details give a different ID along with a message that indicates that you do not have access.
    • There are a variety of different request types that all will be able to respond with a variety of different error messages.   The consistent behavior will be to have a "success" indicator that returns false 

    2)  The NVR API is built on a standardized web service foundation.   All communication to and responses from the API will utilize JSON data formats.   This allows developers to work with any technology stack of their choosing. 

     

    3) There is no associated SDK that NetLook is publishing for the NVR API

     

    4) The API data set is augmented with new data elements as they are built in to the NetLook system.   Historically, we have not deprecated any functionality from the NVR API.  There are possible commercial requirements that would necessitate changes to the API.  NetLook does reserve the right to make changes as they are commercially required. 

     

    5) NetLook supports the legacy function of the NVR API as long as is viable.   As noted, to date, we have not experienced a specific need to deprecate any features.   When changes or updates occur, the system is verified against legacy requests to ensure the continuity of service to the integrated partners.   If any change did require partner modifications, we would notify at least 30 days in advance of the changes and make sure to coordinate updates to the NVR API and the partner integration prior to modification. 

     

    6)  There are sample code snippets available in regards to the data listener here:
    http://api.netlook.com/api/notifications.jsp

     

    Also there are code examples available in the technical guides as well, here:
    http://api.netlook.com/api/apidoc/index.html

     

    We do not currently have any end to end code samples available. 

     

    7) We currently have several measures in place to limit abuse of the API system.   Each account is monitored for excessive traffic and will automatically cut off when it exceeds a maximum threshold.   The cutoff point is generous enough that we have not had any trouble with legitimate partners who need to extract significant amounts of data.   There is also a limiter that places a brake on repeat requests.   We will slow down and eventually stop responding to duplicate requests that look more like a DOS attack against the API than legitimate data requests. 

     

    8) The limitations of usage on the API are set by the dealers who own the inventory data.   Ultimately, Netlook's position is that this data belongs to the automotive dealership customer.   The dealerships are free to determine what data is accessible and what level of access each partner has to reading or manipulating that data.  NetLook does not place a charge or a limit on legitimate use of the data as requested by the automotive dealership that owns the data. 

     

     

    0

Please sign in to leave a comment.

Powered by Zendesk