Product Data with PHP and JSON

For this guide, we're going to assume the following you're interested in using Datafiniti's product data to analyze trends in the women's luxury shoe market. Let's say you're a data scientist that's been tasked with the following:

Collect pricing data on women's luxury shoes from multiple online retailers.
Sort the data by brand.
Determine the average price of each brand.

Your environment and data needs:

You're working with PHP.
You want to work with JSON data.

Here are the steps we'll take:

1. Open a code editor

If you want to use PHP to access the Datafiniti API, we're assuming you'll be using a standard code editor to write your PHP code. Open your code editor to get started.

2. Get your API token

The next thing you'll need is your API token. The API token lets you authenticate with Datafiniti API and tells it who you are, what you have access to, and so on. Without it, you can't use the API.

To get your API token, go the Datafiniti Web Portal (https://portal.datafiniti.co), login, and click your settings in the left navigation bar. From there, you'll see a page showing your token. Your API token will be a long string of letters and numbers. Copy the API token or store it somewhere you can easily reference.

For security reasons, your API token will be automatically changed whenever you change your password.

📘
For the rest of this document, we'll use AAAXXXXXXXXXXXX as a substitute example for your actual API token when showing example API calls.

3. Run your first search

The first thing we'll do is do a test search that will give us a sense for what sort of data might be available. Eventually we'll refine our search so that we get back the most relevant data.

Since we want hotels, let's try a simple search that will just give us online listings for hotels.

Write the following code in your code editor (replace the dummy API token with your real API token):

<?php
/*
  Illustrates an API call to Datafiniti's Business Database for hotels.
*/

$url = 'https://api.datafiniti.co/v4/products/search';

// Set your API parameters here.
$APIToken = 'AAAXXXXXXXXXXXX';
$format = 'JSON';
$query = 'categories:shoes';
$num_records = 1;
$download = false;

$request_body = array(
	'query' => $query,
	'format' => $format,
	'num_records' => $num_records,
	'download' => $download
);

$options = array(
	'http' => array (
		'header'  => "Authorization: Bearer " . $APIToken . "\r\n" . 
					 "Content-Type: application/json\r\n",
		'method'  => 'POST',
		'content' => json_encode($request_body)
	)
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
	echo "Error.";
} else {
	var_dump($result);
}

?>

You should get a response similar to this:

Let's break down each of the parameters we sent in our request:

API Call Component	Description
`"query": "categories:shoes"`	`query` tells the API what query you want to use. In this case, you're telling the API you want to search by `categories`. Any product that has `shoes` listed in its `categories` field will be returned.
`"num_records": 1`	`num_records` tells the API how many records to return in its response. In this case, you just want to see 1 matching record.

Now let's dive through the response the API returned:

Response Field	Description
`"num_found"`	The total number of available records in the database that match your query. If you end up downloading the entire data set, this is how many records you'll use.
`"total_cost"`	The number of credits this request has cost you. Product records only cost 1 credit per record.
`"records"`	The first available matches to your query. If there are no matches, this field will be empty. Within each record returned, you'll see multiple fields shown. This is the data for each record.

Within the records field, you'll see a single product returned with multiple fields and the values associated with that product. The JSON response will show all fields that have a value. It won't show any fields that don't have a value.

Each product record will have multiple fields associated with it. You can see a full list of available fields in our Product Data Schema.

4. Refine your search

If you take a look at the sample record shown above, you'll notice that it's not actually a pair of shoes. It's actually a shirt. It was returned as a match because its category keywords included Clothing, Shoes & Jewelry. If we downloaded all matching records, we would find several products that really are shoes, but we'd also find other products like this one, which aren't.

We'll need to refine our search to make sure we're only getting shoes. Modify your code to look like this:

<?php
/*
  Illustrates an API call to Datafiniti's Business Database for hotels.
*/

$url = 'https://api.datafiniti.co/v4/products/search';

// Set your API parameters here.
$APIToken = 'AAAXXXXXXXXXXXX';
$format = 'JSON';
$query = 'categories:shoes AND -categories:shirts AND categories:women AND (brand:* OR manufacturer:*) AND prices:*';
$num_records = 10;
$download = false;

$request_body = array(
	'query' => $query,
	'format' => $format,
	'num_records' => $num_records,
	'download' => $download
);

$options = array(
	'http' => array (
		'header'  => "Authorization: Bearer " . $APIToken . "\r\n" . 
					 "Content-Type: application/json\r\n",
		'method'  => 'POST',
		'content' => json_encode($request_body)
	)
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
	echo "Error.";
} else {
	var_dump($result);
}

?>

This code is different in a couple ways:

It uses AND -categories:shirts to filter out any products that might be shirts. Note the - in front of categories.
It adds AND categories:women to narrow down results to just products for women. (We were interested in just women's shoes.)
It adds AND (brand:* OR manufacturer:*). This ensures the brand or manufacturer field is filled out in all the records I request. We call the * a "wildcard" value. Matching against a wildcard is a useful way to ensure the fields you're searching aren't empty.
It adds AND prices:*. Again, matching against a wildcard here means we're sure to only get products that have pricing information.
It changes records=1 to records=10 so we can look at more sample matches.

🚧
If num_records is not specified, ALL of the records matching the query will be downloaded.

Notice how Datafiniti lets you construct very refined boolean queries. In the API call above, we're using a mix of AND and OR to get exactly what we want.

🚧
When using the API, you will not receive any warning if you are going past your monthly record limit. Keep a track on how many records you have left by checking your account. You are responsible for any overage fees if you go past your monthly limit.

If you would like to narrow your search to just exact matches you can place the search term in quotation marks.

<?php
/*
  Illustrates an API call to Datafiniti's Business Database for hotels.
*/

$url = 'https://api.datafiniti.co/v4/products/search';

// Set your API parameters here.
$APIToken = 'AAAXXXXXXXXXXXX';
$format = 'JSON';
$query = 'name:"Apple Iphone 10"';
$num_records = 10;
$download = false;

$request_body = array(
	'query' => $query,
	'format' => $format,
	'num_records' => $num_records,
	'download' => $download
);

$options = array(
	'http' => array (
		'header'  => "Authorization: Bearer " . $APIToken . "\r\n" . 
					 "Content-Type: application/json\r\n",
		'method'  => 'POST',
		'content' => json_encode($request_body)
	)
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
	echo "Error.";
} else {
	var_dump($result);
}

?>

The above query will only return products with the exact name of Apple Iphone 10.

5. Initiate a download of the data

Once we like what we see from the sample matches, it's time to download a larger data set! To do this, we're going to update our code a fair bit (an explanation follows):

<?php
/*
  Illustrates how to download a full data set from Datafiniti's Business Database.
*/

$request_url = 'https://api.datafiniti.co/v4/products/search';

// Set your API parameters here.
$API_token = 'AAAXXXXXXXX';
$format = 'JSON';
$query = 'categories:shoes AND -categories:shirts AND categories:women AND (brand:* OR manufacturer:*) AND prices:*';
$num_records = 50;
$download = true;

$request_body = array(
	'query' => $query,
  'num_records' => $num_records,
	'format' => $format,
	'download' => $download
);

$request_options = array(
	'http' => array (
		'header'  => "Authorization: Bearer " . $API_token . "\r\n" . 
					 "Content-Type: application/json\r\n",
		'method'  => 'POST',
		'content' => json_encode($request_body)
	)
);

// Make the initial API call.
echo "Making initial request...\n";
print_r($request_options);
$request_context  = stream_context_create($request_options);
$request_response = file_get_contents($request_url, false, $request_context);

if ($request_response === FALSE) {

	echo "Error.";
	var_dump($request_response);

} else {

	echo "Download request successful:\n";
	$request_response_array = json_decode($request_response,true);
	print_r($request_response_array);

	$download_id = $request_response_array['id'];
	$download_url = 'https://api.datafiniti.co/v4/downloads/' . $download_id;
	$download_options = array(
		'http' => array (
			'header'  => "Authorization: Bearer " . $API_token . "\r\n",
			'method'  => 'GET'
		)
	);
	$download_status = 'running';
	while ($download_status != 'completed') {
		sleep(10);
		echo "Checking on status: " . $download_url . "\n";
		$download_context  = stream_context_create($download_options);
		$download_response = file_get_contents($download_url, false, $download_context);		
		$download_response_array = json_decode($download_response,true);
		$download_status = $download_response_array['status'];
		echo "Records downloaded: " . $download_response_array['num_downloaded'] . "\n";
	}

	if ($download_status == 'completed') {
		$result_list = $download_response_array['results'];
		for ($i = 0; $i < count($result_list); $i++) {
			$result_link = $result_list[$i];
			$filename = $download_id . "_" . $i . "." . $format;
			file_put_contents($filename, fopen($result_link, 'r'));
			echo "File " . ($i+1) . " out of " . count($result_list) . " saved: " . $filename . "\n";
		}
	}
}

?>

A couple things to pay attention to in the above code:

We changed num_records from 10 to 50. This will download the first 50 matching records. If we wanted to download all matching records, we would remove num_records. num_records will tell the API to default to all available records.
We changed download from false to true.

Since we've handled multiple steps of the download process in this code, we won't go into the details here, but we do recommend you familiarize yourself with those steps. Checking them out in our Product Data with Postman and JSON guide.

6. Parse the JSON data

The download code will save one or more result files to your project folder.

📘
The JSON data will actually be a text file, instead of a single JSON object. Each line in the text file is a JSON object. We format the data this way because most programming languages won't handle parsing the entire data set as a JSON object with their standard system calls very well.

We'll need to parse the file into an array of JSON objects. We can use code similar to this to handle the parsing:

<?php

// Set the location of your file here
$file = "xxxx_x.txt";

$records = array();

$handle = fopen($file, "r");
if ($handle) {
	while (($line = fgets($handle)) !== false) {
		$records[] = json_decode(($line));
	}
} else {
	echo "Error opening file.";
}

foreach($records as $record) {
	// Edit these lines to do more with the data.
	print_r($record);
}

?>

You can edit the code in the foreach loop above to do whatever you'd like with the data, such as store the data in a database, write it out to your console, etc.