Third Party Integration Guide

Sending a Sales Enquiry to Navigator

Web site enquiries can be sent back into Navigator where they are automatically converted into Sales Enquiries. Navigator Sales People can be organised into Teams (eg Used Sales Team or Contact Centre Team) and enquiries can be automatically routed to the correct team .

There are two ways that an enquiry can be sent back to Navigator :-

Web Service

The most comprehensive way of creating an enquiry is to use a Web Service. This is a RESTful service supporting POST and takes an XML or JSON document which is structured to send the enquiry into Navigator.

The web service supports a mandatory Api Key which is supplied by Navigator - specific to each customer system interface - please contact Navigator for test and live Api Keys

A Sales Enquiry can be created from a web service very easily.  

This can be used from a Web Site or from within an Application

Examples of use may be :-

1. Customer Enquiry on a Vehicle

2. Part Exchange Online Valuation

3. Online Finance Affordability calculator

4. Test Drive Booking Application

The follow details can be sent:-

Customer Details

Title

FirstName

Surname

Address1

Address2

Address3

Address4

Address5

Telephone

WorkNo

MobileNo

Email

Note: a name and  telephone no or email are mandatory.

Enquiry Details

LeadType

LeadSource

LeadSubSource

Note

Team

ChangeDate

Budget

Vehicle Interest

WantedStockNo

EnquiryRegNo

MakeWanted

ModelWanted

NewUsed

ColourRequired

Either a WantedStockNo (the Navigator stock no as supplied in a vehicle stock feed - see here

Part Exchange

PxReg

PxMake

PxModel

PxMileage

PxValue

Finance

FinanceAnnualMileage

FinanceType

FinanceMonthlyPayment

FinanceTerm

FinanceDeposit

FinanceLenderName

FinanceFinalPayment

Test Drive

TestDriveLocation

TestDriveAddress

TestDriveDate

TestDriveStartTime

TestDriveEndTime

An example using curl with xml is :-

curl -X POST 'https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/CallProgExt' `

-H 'Content-Type: text/plain' `

--data-raw '<request>

<apikey>xxxxxxxxxxxxxxxxxxxxxxxxxx</apikey>

<sessionid>12345</sessionid>

<method>WEBT_SALES_LEAD_CREATE</method>

<parameters>

      <Team>1</Team>

      <Title>Mrs</Title>

      <FirstName>Amy</FirstName>

      <Surname>Silver</Surname>

      <Email>amylsilver@email.com</Email>

      <MobileNo>07388744444</MobileNo>

      <EnquiryRegNo>S11SPV</EnquiryRegNo>

      <MakeWanted>SKODA</MakeWanted>

      <ModelWanted>RAPID SPACEBACK</ModelWanted>

      <LeadType>Test Drive Request</LeadType>

      <LeadSource>Test Drive App</LeadSource>

      <LeadSubSource>OnSite Visit</LeadSubSource>      

      <Notes>Test Drive Request

             Driving Licence No yyyyyyyyyyyyyyy</Notes>

</parameters>

</request>'

The same call using JSON :-

curl -X POST 'https://services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/CallProgExt' `

-H 'Content-Type: text/plain' `

--data-raw '{

"request": {

 "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

 "sessionid": 12345,

 "method": "WEBT_SALES_LEAD_CREATE",

 "parameters": {

   "Team": 1,

   "Title": "Mrs",

   "FirstName": "Amy",

   "Surname": "Silver",

   "Email": "amylsilver@email.com",

   "MobileNo": 07388744444,

   "EnquiryRegNo": "S11SPV",

   "MakeWanted": "SKODA",

   "ModelWanted": "RAPID SPACEBACK",

   "LeadType": "Test Drive Request",

   "LeadSource": "Test Drive App",

   "LeadSubSource": "OnSite Visit",

   "Notes": "Test Drive Request \nDriving Licence No yyyyyyyyyyyyyyyy"

  }

}

}'

An example of this in use in a web page can be seen in the following example - which is built using html and jquery.  The actual web page can be viewed at

web page example <html>
<head>
  <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
  <script src="http://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
  <script>
      < !this accesses the url variables in the URL! >
          function getUrlVars() {
              var vars = {};
              var parts = window.location.href.replace(/[?&]+([^=&]+)=([^&]*)/gi, function(m, key, value) {
                  vars[key] = value;
              });
              return vars;
          }
  </script>
  <script>
      < !In the next
      function the * * _rendered - form_ * * is the id of the form(see the < form > tag) ! >
          $(document).ready(function() {
              $('#rendered-form').submit(function(event) {
                  event.preventDefault();
                  < !gets the data from the form! >
                      var Title = document.forms["rendered-form"].elements["Title"].value;
                  var FirstName = document.forms["rendered-form"].elements["First-Name"].value;
                  var Surname = document.forms["rendered-form"].elements["Surname"].value;
                  var Email = document.forms["rendered-form"].elements["Email"].value;
                  var Notes = document.forms["rendered-form"].elements["Note"].value;
                  < !the next line comes from the URL! >
                      var ApiKey = getUrlVars()["apikey"]
                  < !builds the URL and xml to post a sales lead
                  for example! >
                      var settings = {
                          "url": "https://staging-services.dmservices.co.uk/DmsNavigator.NavigatorWebService.svc/CallProgExt",
                          "method": "POST",
                          "timeout": 0,
                          "data": "<request><apikey>" + ApiKey + "</apikey><sessionid>12345</sessionid><method>WEBT_SALES_LEAD_CREATE</method><parameters><FirstName>" + FirstName + "</FirstName><Surname>" + Surname + "</Surname><Email>" + Email + "</Email><Notes>" + Notes + "</Notes><Team>1</Team></parameters></request>\r\n",
                      };
                  $.ajax(settings).done(function(response) {
                      alert("Submitted");
                  });
              });
          });
  </script>
  <title>Navigator Demonstration Sales lead creator</title>
</head>
<body>
  <img src="logo_navigator-193x65.jpg">
  <h1>Navigator Sales 360 Demonstration Contact Form</h1>
  <br>
  <form method="POST" id="rendered-form">
      <div class="rendered-form">
          <div class="fb-text form-group field-Title">
              <label for="Title" class="fb-text-label">Title</label>
              <input type="text" class="form-control" name="Title" id="Title">
          </div>
          <div class="fb-text form-group field-First-Name">
              <label for="First-Name" class="fb-text-label">First Name</label>
              <input type="text" class="form-control" name="First-Name" id="First-Name">
          </div>
          <div class="fb-text form-group field-Surname">
              <label for="Surname" class="fb-text-label">Surname</label>
              <input type="text" class="form-control" name="Surname" id="Surname">
          </div>
          <div class="fb-text form-group field-Email">
              <label for="Email" class="fb-text-label">Email Address</label>
              <input type="text" class="form-control" name="Email" id="Email">
          </div>
          <div class="fb-textarea form-group field-Note">
              <label for="Note" class="fb-textarea-label">Comments</label>
              <textarea type="textarea" class="form-control" name="Note" id="Note"></textarea>
          </div>
          <div class="fb-button form-group field-submit">
              <input type="submit" class="btn-default btn" name="submit" style="default" id="submit" value="submit" />
          </div>
      </div>
  </form>
</body>
</html>

Notes:-

Sales Enquiries are classified in Navigator by the following parameters :-

LeadType

This is the Type of Lead in text form, this may be supplied by the dealer for reporting analysis and generally contains text such as "Internet",  "On Site", "Telephone".  

LeadSource & LeadSubSource

This is the source of the Lead - it has a main and sub classification

Again, this is normally supplied by the dealer, but examples may be Internet / Web Site Enquiry or Internet / Test Drive Request   for example

Sales Enquries are routed to Sales Teams.   The dealer can create teams of Sales Executives who will have visibility of enquiries routed to that team.  A Sales Executive may be part of multiple teams

Some examples of teams may be by branch location, new or used sales enquiries, or perhaps by Make of Vehicle if they have franchise specialists.  

The team no will be supplied by the dealer though no 1 should normally work for initial testing!

>>> contact your customer success manager