Main menu About us Contact us Affiliate related Franchise & Investment Job opportunity Data feed

Feed Application Programming Interface (API) guide

If you have any suggestions that would make working with this API any easier please contact us at feeds@dealerlogin.co



The API based on Simple Object Access Protocol (SOAP) and Web Services Description Language (WSDL).

All actions are determined by special partner KeyToken, that you will receive after making request to feeds@dealerlogin.co or maybe via other contacts that you know. Without this key you will not be able to use our API.


This Application Programming Interface contains two most needed services:

  • Vehicle Service - Allows to pull a whole vehicle stock that availiable for partner KeyToken; To check actuality of the vehicle ads using the vehicle unique id; To get a list of possible values ​​for the fields; Etc.
  • Lead Service - Allows to post the leads for specified vehicle using vehicle unique id and vehicle requests into the Dealer Login system and send them directly to the dealers. All leads will be marked as leads from your source / website.

Vehicle Service

EXAMPLE OF HOW TO USE

This service contains the next functions:

  • $client->getVehicles();

    Description: Returns a whole vehicle stock that currently availiable for partner KeyToken. The vehicle that already sold or deleted missing in this list.
    URL for Soap Client: https://www.dealerlogin.co/za/wsdl-service/vehicles
    Return: ArrayOfVehicle which is an array containing Vehicle elements, each Vehicle has the following fields:
    Name Description
    VehicleID The vehicle unique identifier
    VehicleType The vehicle type, e.g. New Car, Used Car, Bike
    VehicleBrand The vehicle manufacturer
    VehicleModel The vehicle model, without additional details
    VehicleUserModel The vehicle model, with additional details e.g. 1.6TDi exclusive
    VehicleYear The vehicles year of first registration.
    VehicleMileage The data from the vehicle Odometer (km)
    VehicleBodyType The vehicle body type e.g. Sedan, Coupe
    VehicleTransmission The vehicle gearbox type e.g. Automatic, Manual
    VehicleFuel The vehicle type of fuel e.g. Petrol, Diesel
    VehicleEngine The vehicle engine capacity (cm³)
    VehiclePrice The retail price of the vehicle
    VehicleColour The colour of the vehicle
    VehicleDrivingSide The vehicle driving side e.g. Right Hand Drive, Left Hand Drive
    VehicleTraction The vehicle traction e.g. Front-wheel drive, 4x4, 4x2
    VehicleWarranty Free text describing the vehicle warranty details
    VehicleFinance The vehicle finance (available or not available)
    VehicleServicePlan Free text describing the vehicle service plan
    VehicleMotorPlan Free text describing the vehicle motor plan
    VehicleHistory Indicates the service history of the vehicle e.g. full, no
    MMCode The Transunion Mead & Mcgrouther code of the vehicle
    VehicleExtras The vehicle extras e.g. Climate Control, Power Steering (comma separated)
    Comments Free text that contains additional information about the vehicle
    PostDate The date that this vehicle was added
    VehiclePhotos The array of urls to full size images

    Each Vehicle has a Dealership array containing Dealership elements, each Dealership has the following fields:
    Name Description
    ID The dealership unique identifier
    Name The dealership name
    Region The dealership region
    City The dealership city
    Email The email address of the person who can be contacted about the vehicle (can be a few, comma separated)
    CellPhoneNumber The cell number of the person who can be contacted about the vehicle
    PhoneNumber The dealership contact phone number
    ContactPerson The telephone number of the person who can be contacted about the vehicle
  • $client->isAvailable($VehicleID);

    Description: Checking, if the specific vehicle is available in stock to sell.
    URL for Soap Client: https://www.dealerlogin.co/za/wsdl-service/vehicles
    Parameters:
    Name Description
    VehicleID The vehicle unique identifier
    Return: True if available or False if not available
  • $client->getPossibleValues($ElementName);

    Description: Return the list of currently possible values
    URL for Soap Client: https://www.dealerlogin.co/za/wsdl-service/vehicles
    Parameters:
    Name Description
    ElementName The name of the field from the ArrayOfVehicle, e.g. VehicleBrand, VehicleBodyType, Region
    Return: Array of the currently possible values for the specified field name
  • Example of How to use the Vehicle Service:

    $header = new SoapHeader('http://tempuri.org/', 'KeyToken', 'XXXX-XXXX-XXXX-XXXX');

    $client = new SoapClient("https://www.dealerlogin.co/za/wsdl-service/vehicles");
    $client->__setSoapHeaders($header);

    $vehicles = $client->getVehicles();

    foreach($vehicles as $vehicle) {
        echo $vehicle->VehicleID;
    }

    var_dump($vehicles);

This service contains the next functions:

  • $client->sendLead($Lead);

    Description: Create a lead based on a user enquiry, post it to the Dealer Login system and send the notification message to the dealer via email and sms.
    URL for Soap Client: https://www.dealerlogin.co/za/wsdl-service/leads
    Parameters: The Lead array with the customer contact information and vehicle unique identifier. Lead array contains the following fields:
    Name Description
    VehicleID The vehicle unique identifier the customer is interested in. Required.
    CustomerName Name of customer, which created the lead. Required.
    CustomerSurname Surname of customer, which created the lead
    CustomerRegion The province that the customer, which creates the lead is interested in. Required.
    CustomerPhone Tel number of customer, which created the lead. Required.
    CustomerEmail Email address of the customer, which created the lead. Required.
    CustomerMessage Customer comments
    LeadCreatedDate The UnixTimestamp that the lead was created.
    isMobile Mark. Is this lead is created using mobile. True / False.
    False by default.
    CustomerIP The IP address of the customer, which created the lead
    Return: Returns a Result element which contains the following fields:
    Name Description
    Message If an error has occurred will contain error message. Otherwise, will contain the success message.
    Success Indicates whether the lead was submitted successfully. Returns True for success and False for failure.
  • $client->sendRequest($Lead);

    Description: Create a request based on a user enquiry, post it to the Dealer Login system and send the notification message to the dealers via email.
    URL for Soap Client: https://www.dealerlogin.co/za/wsdl-service/leads
    Parameters: The Lead array with the contact information of the person, while looks a specific car. Lead array contains the following fields:
    Name Description
    CustomerName Name of person who created the request. Required.
    CustomerPhone Tel number of person who created the request. Required.
    CustomerEmail Email address of person who created the request. Required.
    CustomerMessage Customer comments and the vehicle details, that the person looks for. Required.
    LeadCreatedDate The UnixTimestamp that the request was created.
    isMobile Mark. Is this request is created using mobile. True / False.
    False by default.
    CustomerIP The IP address of the person who created the request
    Return: Returns a Result element which contains the following fields:
    Name Description
    Message If an error has occurred will contain error message. Otherwise, will contain the success message.
    Success Indicates whether the request was submitted successfully. Returns True for success and False for failure.
  • Example of How to use the Lead Service:

    $header = new SoapHeader('http://tempuri.org/', 'KeyToken', 'XXXX-XXXX-XXXX-XXXX');

    $client = new SoapClient("https://www.dealerlogin.co/za/wsdl-service/leads");
    $client->__setSoapHeaders($header);

    $Lead = $client->Lead;

    $Lead->VehicleID = 255464;
    $Lead->CustomerName = "Patrick";
    $Lead->CustomerSurname = "Kabelo";
    $Lead->CustomerRegion = "Gauteng";
    $Lead->CustomerPhone = "0785582367";
    $Lead->CustomerEmail = "example@gmail.com";
    $Lead->CustomerMessage = "I'm interested in this car. Please call me!";
    $Lead->LeadCreatedDate = time();
    $Lead->CustomerIP = $_SERVER[REMOTE_ADDR]

    $result = $client->sendLead($Lead);

    var_dump($result);

If you have any suggestions that would make working with this API any easier please contact us at feeds@dealerlogin.co

Copyright © 2017 DealerLogin.co
All rights reserved