API Management - How To Set Up Vehicle Look Ups MotorWeb Carjam CarChecker PPSR

API Management - How To Set Up Vehicle Look Ups (MotorWeb, Carjam, CarChecker, PPSR)

The Vehicle Appraisal Form allows users to use built in Vehicle Lookups including;
  1. MotorWeb NZ
  2. Carjam NZ
  3. Checka NZ
  4. Autocheck NZ
  5. MotorCentral CarCheck
  6. MotorWeb AU
  7. PPSR AU
Each function displays by default for all clients and users.  Access to use the Vehicle Lookups is controlled via the following roles.  The roles are all yard and user based.  The manager flag has no effect.
  1. Carjam Vehicle Check role (NZ)
  2. MotorCentral Car Check role (NZ)
  3. Checka Basic (NZ)
  4. Checka Full (NZ)
  5. Autocheck NZ (NZ)
  6. MotorWeb Appraisal Report role (NZ)
  7. MotorWeb VIR Australia role (AUS)
  8. PPSR Australia role (AUS)
If a client has not been set up with any of the roles above they will receive a prompt to contact their supplier to request set up.  If the client has been set up, but the user has not the user will be prompted to request set up from their manager.  

As well as the role, AutoPlay staff members must set up an API record via Settings>Company Settings>API Management



You need to choose the appropriate API from the options available.  
  1. KEY & TOKEN - Most API's require a unique Key & Token in order to access the API.  MotorWeb AU & PPSR do not need an API key as they bill AutoPlay directly and we then on-bill.
  2. NAME - Name the API record with a logical name (i.e MotorWeb AU Lookup)
  3. TOKEN EXPIRES - set an expiry date in 2025
  4. ACTIVE - To ensure the logo and button make sure to tick the 'Active' checkbox.  To hide one of the Vehicle Lookups you must create an API record for that client, but then mark as inactive by un-ticking the 'Active' checkbox.
  5. YARDS - If the access to the API is to be restricted by yards within the account, this can be restricted by selecting Yards in the 'Yards' section.


    • Related Articles

    • Role Management - Vehicle Lookup Services

      There are a number of vehicle lookups that can be completed within the Vehicle Appraisal Form.  To enable these options within your account there are a number of Role Management Settings.  Please note - it is not possible to use any of these services ...

    • Role Management - RIPA API Push

      RIPA are a website portal that AutoPlay have an agreement to send Appraisal and Listing data to.  The Appraisals are triggered to be sent to RIPA on the Appraisal Form, whilst listings can be triggered from the View Listing screen.  To have access to ...

    • Role Management - Vehicle Wishlist & Email

      The Vehicle Wishlist & Email Role controls the notifications sent to users when a Wishlist matches against an existing Listing or Appraisal. When the Wishlist Matching routine runs, any users in this role will be emailed if one of their clients' ...

    • Role Management - Redbook Australia Role

      It is now possible to complete a Redbook Vehicle lookup from within AutoPlay. This is not available by default - please contact support@autoplay.com.au to request access. The functionality is controlled by a role called 'Redbook Australia'. Role ...

    • Role Management - Loan Vehicle

      The Loan Vehicle role activates the ability to load a Loan Vehicle from the Vehicle Registry screen (via the + menu on iPad and the RHS buttons on Desktop). If the User is added to the list they will be able to see their own Loan Car Forms, whilst if ...