Description API - DealerWriter

Description API Integrate with your inventory provider

DealerWriter features a simple RESTful API to provide your inventory provider access to your descriptions. Using the Description API, at the inventory provider level, your descriptions will be written in RealTime and pushed to your website and 3rd party vendors automatically. Implemention is recommended server-side to protect your DealerWriter account against unauthorized use. This API is available via GET and returns a JSON response. All modern new and used vehicles are supported. E-mail support@dealerwriter.com with any questions or concerns.

API GET Request - Keys And Descriptions

DealerWriter will return a JSON array that has the following information.

Key	Description
error	Set to true, the array (besides 'error_msg') will be blank. false means everything succeeded.
error_msg	Describes the error that occured, otherwise blank.
vin	Returned VIN number or blank on errors.
balance	Remaining account balance.
description	Vehicle description that was written. It reflects current options from Settings.
ws_pdf	URL to the PDF version of the window sticker.
ws_jpg	URL to the JPG version of the window sticker.

Best Practices

There are two recommended options for inventory provider implementation. The dealership should pick the one that works best for their needs within their DealerWriter account limits.

#1: Implement the Description API during processing of the DMS feed. It should be ran automatically for vehicles which are new to the Dealerships inventory with the written description being stored. For existing vehicles, Description API should be skipped. Using this practice, all newly added vehicles will have descriptions written automatically. All previously existing inventory will be ignored.

#2: Add a HTML button to the Update Vehicle page (where the user enters/edits a description). The buttons onClick attribute should trigger an AJAX call to Description API. The description should be returned to the HTML textarea via JavaScript for further editing or saving. Be aware the API key is visible, do not use this method outside of secure Dealership access. Using this practice, the Dealership has more control over which vehicles they get descriptions written for. The downside being it won't be done automatically.

Simple PHP Implementation (Server-side)

$key = 'API-KEY-HERE';
$vin = 'VIN-NUM-HERE';
$url = 'https://dealerwriter.com/api/v1/?key='.$key.'&vin='.$vin;	// Fully formed url
$content = file_get_contents($url);					// Obtain the GET request
if ($content === false) { /* Connection error */ }
else {
	$decode = json_decode($content, true);				// Decode JSON
	if ($decode != NULL) {						// Check JSON decode
		if (!$decode['error']) {				// Check DealerWriter response
			$vin = $decode['vin'];				/* VIN number */
			$balance = $decode['balance'];			/* Account balance left */
			$description = $decode['description'];		/* Description */
			$ws_pdf = $decode['ws_pdf'];			/* Window Sticker PDF */
			$ws_jpg = $decode['ws_jpg'];			/* Window Sticker JPG */
		}
		else { /* DealerWriter response error - Check $decode['error_msg'] */ }
	}
	else { /* JSON decode error */ }
}

Simple JavaScript Implementation (Client-side)

<input id="dwbutton" type="button" value="DealerWriter" onclick="dealerWriter('VIN-NUM-HERE', 'API-KEY-HERE')">

<textarea id="dwdescription" rows="20" cols="65"></textarea>

<script>
function dealerWriter(vin, key) {
	var url = 'https://dealerwriter.com/api/v1/?key=' + key + '&vin=' + vin;
	var xhttp = new XMLHttpRequest();
	xhttp.onreadystatechange = function() {
		if (this.readyState == 4 && this.status == 200) {
			var decode = JSON.parse(this.responseText);
			if (!decode['error']) {
				/* DealerWriter responded with a description */
				document.getElementById('dwdescription').value = decode['description'];
			}
			else { 
				/* DealerWriter response error - Change to fit your needs */
				document.getElementById('dwdescription').value = decode['error_msg'];
			}
  		}
  	};
	xhttp.open('GET', url, true);
	xhttp.send();
}
</script>

Be aware the API key is visible, do not use this method outside of secure Dealership access.

API Sample Response

error:false

{
   "error":false,
   "error_msg":"None.",
   "vin":"2C3CDXCT0GH203464",
   "balance":999,
   "description":"Clean CARFAX - Certified Pre-Owned - Bluetooth - Heated Seats - 20\" Rims\n\nPushing the limits with brilliant design and seemingly infinite capacity, our 2016 Dodge Charger r\/t in Billet Clearcoat is the pinnacle of performance, prestige, and precision!  Powered by a purpose built 5.7-liter V8 engine that offers unbeatable horsepower while perfectly paired with a 8-speed Automatic transmission.  Enjoy this Rear Wheel Drive sedan's smooth ride that's easy and responsive as you attain 25mpg along the way!  You will find this one has a strong road presence!  Sculpted to aerodynamic perfection, our Charger r\/t is an absolute show-stopper with Quick Order Package 29 N R\/T, LED brake lights, a lip spoiler, push button start, a stainless steel exhaust, and remote keyless entry.  You'll appreciate a wealth of amenities including a mobile hotspot, Bluetooth connectivity, SiriusXM satellite radio, and an audio input jack.  Our Charger r\/t exudes timeless elegance accented by a dash of sophistication thanks to heated front seats, and many other exclusive features.  Enjoy a sterling reputation for reliability and safety with a tire pressure monitoring system, a valet function, a traction control system, and electronic stability control.  With inspired styling and luxurious amenities, this brilliant machine is a must-see, must-drive!\n\nOriginal Warranties offered by Dodge:\nDrivetrain - 5 year \/ 60,000 mile\nCorrosion - 5 year \/ Unlimited mile\nRoadside Assistance - 5 year \/ 100,000 mile",
   "ws_pdf":"https:\/\/dealerwriter.com\/sample@email.com\/pdf\/2C3CDXCT0GH203464.pdf",
   "ws_jpg":"https:\/\/dealerwriter.com\/sample@email.com\/jpg\/2C3CDXCT0GH203464.jpg"
}

error:true

{
   "error":true,
   "error_msg":"API key invalid.",
   "vin":"",
   "balance":"",
   "description":"",
   "ws_pdf":"",
   "ws_jpg":""
}

error_msg - Values And Descriptions

Value	Description
API key missing.	The required API key wasn't included in the GET request.
API key invalid.	The supplied API key isn't assigned to any DealerWriter user.
VIN contains invalid characters.	The VIN should be alphanumeric characters only.
VIN failed validation.	The supplied VIN number failed check digit validation.
No balance left to purchase.	The balance is at zero and the supplied VIN wasn't previously purchased.
Internal DealerWriter error.	DealerWriter experienced an internal error processing the supplied VIN.
None.	Everything was successfully processed and returned.