API: DemonstratorGauge Data Download

API Documentation – DemonstatorGauge Data Download 4 December 2009 - v0.1

What this API does:

SUMMARY: The objective is to provide the correct ID numbers for Demonstrators, Products and Venues in the DemonstratorGauge field marketing system. Using an HTML request, a remote call can be made to the DemonstratorGauge database to retrieve a list of:

• Demonstrators
• Products
• Venues

It is designed to be used in conjunction with the API: DemonstratorGauge Event Upload

Detail:

A correctly formed HTTP request will deliver a file in CSV format of fields from the tables containing demonstrators, products and venues.

Restrictions:

• You are restricted to 100 API calls (total) per day.
• You can only retrieve Venue data for your specified Country
• You can only retrieve Person data for your specified Agency AND country
• You need a valid API key - please request one from API@directness.net

Using the API

To get a list of venues in your country:

http://www.d1-gauge.com/canon/API/GetInfo.php?key=xxxxxxxxx&type=Venue

To get a list of products:

http://www.d1-gauge.com/canon/API/GetInfo.php?key=xxxxxxxxx&type=Product

To get a list of persons/demonstrators for your Agency Name:

http://www.d1-gauge.com/canon/API/GetInfo.php?key=xxxxxxxxx&type=Person

NB Replace xxxxxxxx with your API key.

[caption id="attachment_1355" align="alignnone" width="400" caption="Example Output WIth Person List (restricted to Agency Name)"][/caption]

Example with PHP

<?

// DemonstatorGauge Data Download 4 December 2009 - v0.1

url = "http://www.d1-gauge.com/canon/API/GetInfo.php?key=xxxxxxxxx&type=Product";

// replace xxxxxxxxx with your API key

// type=Product

// type=Venue

// type=Person

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_BINARYTRANSFER, 1);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);

$result = curl_exec($ch);

curl_close($ch);

print $result;

?>

Validation

A CSV (Comma Separated Variable) file can be downloaded.

Error messages:

API Key expired - please ask for a new key
API key not valid - please request key with your API 

Support