Construya un vínculo de afiliado personalizado con la API de Merchandising de productos de Amazon

Spanish (Español) translation by Elías Nicolás (you can also view the original English article)

El programa Amazon Associates, junto con Amazon Web Services (AWS), ofrece a los desarrolladores un poderoso medio para buscar en el catálogo de Amazon Store utilizando una API RESTful e integrar datos para casi cualquier listado de productos en una página web. Si eres un programador con una mentalidad de negocios y buscando formas de monetizar tu sitio, puedes registrarte para ser un afiliado de Amazon y ganar una comisión cada vez que un usuario haga clic en el enlace de producto y complete una compra. (Y en cuanto a los programas de ingresos de afiliados, las comisiones de Amazon están entre las más generosas.)

Para aquellos de ustedes que son nuevos a la idea de marketing de afiliación, supongamos que están ejecutando un blog o sitio web con críticas de películas. Para cada revisión de la película que se publica, puede beneficiarse mediante la inclusión de un enlace para los lectores a comprar la película en algún lugar cerca de su artículo. Para que sea más atractivo hacer clic, el enlace puede incluir una imagen en miniatura del DVD, el nombre completo de la película, el precio más bajo disponible y un botón "Comprar".

En este tutorial, le mostraré cómo crear una clase dedicada y reutilizable en PHP que se conecta a la Product Merchandising API y extrae datos XML basados en el nombre del producto y la categoría de compras (en este caso "Películas"). Al final, vamos a rellenar los datos en una pequeña plantilla HTML completamente personalizable para que acabemos con una demostración de trabajo de un módulo de mini afiliados. Empecemos.

[Tenga en cuenta antes de acceder a la demostración de ejemplo que si usted opta por comprar o alquilar el DVD desde el enlace proporcionado, resultará en un pago de comisión a Envato Tuts+.]

Registro de un ID de afiliado y obtención de credenciales

Primero, regístrese para una cuenta en affiliate-program.amazon.com. Es gratis, y sólo tienes que seguir los pasos para crear un perfil para tu sitio web. Se le pedirá que verifique su identidad al final del proceso ingresando su número de teléfono, recibiendo una llamada automatizada e ingresando el código de acceso que le entregan.

Una vez que haya completado el registro, se le dará un ID de afiliado de Amazon (en este ejemplo, es "envtuts-20"). Inicie sesión en su área de cuenta principal con su nombre de usuario y contraseña y haga clic en la ficha Product Merchandising API. Allí, haga clic en el enlace para empezar a usar la API.

Tendrá que registrarse en Amazon Web Services (aws.amazon.com), si aún no lo ha hecho. En la consola de AWS, en Credenciales de seguridad, puede generar una clave de acceso y clave secreta para realizar solicitudes de API. (Nota: es importante mantener estas credenciales privadas y seguras, nunca exponerlas públicamente en GitHub o en cualquier otro sitio en línea).

Configuración de nuestra PHP Helper Class

Para los propósitos de este ejemplo y para mantener las cosas relativamente sencillas, implementaremos el patrón de diseño de Singleton para crear una clase auxiliar estática llamada AmazonAssocHelper . Incluirá un método público que se conecta a la API, busca en el catálogo y devuelve los datos del producto utilizando ciertos parámetros que pasamos. Así es como lo configuro:

<?php


namespace App\Services;

use App\lib\vendor\aws\AWSSignedRequest;


class AmazonAssocHelper {

  //AMAZON AFFILIATE PROGRAM ACCESS -- sign into affiliate-program.amazon.com
	const AMZ_ASSOC_TAG = 'your-affiliate-id';

	//AWS credentials -- sign into aws.amazon.com
	const AMZ_ASSOC_ACCESSKEY = 'YOUR_ACCESS_KEY';  
	const AMZ_ASSOC_SECRETKEY = 'YOUR_SECRET_KEY';  

	//Set the values for some of the search parameters
	private static $operation = "ItemSearch";
	private static $version = "2013-08-01";
	private static $response_group = "Small,Images,OfferSummary";

	protected function __construct() {

	}

	/**
	* Fetches relevant product data in product API from keyphrase and category
	* returns: array of data from the top result node
	*/
	public static function fetch_product_data($keyphrase, $category) {
	
		$result_xml = self::get_search_results($keyphrase, $category);
		
		//return an array containing the item name, link, image, and price
		return self::get_top_result_data($result_xml);
	
	}


}

El primer par de líneas declaran un namespace para nuestra clase e incluyen una clase de terceros que necesitaremos para hacer una solicitud firmada a la API con nuestras credenciales. Las tres constantes que he definido son nuestros ID de afiliado, que obtuvimos después de registrarnos, y la clave de acceso y clave secreta de AWS. Cuando hacemos nuestras solicitudes de API, el ID de afiliado se inserta automáticamente en el vínculo de producto que recuperamos para que las compras se puedan rastrear adecuadamente a nuestra cuenta y ¡nos pagan! Asegúrese de llenar los tres valores para usted.

Las tres variables privadas se refieren a los parámetros de búsqueda que suministraremos para cada solicitud. Estoy usando "ItemSearch" como nuestra opción de operación para buscar resultados. "2013-08-01" es la fecha de la última versión de la API, que también debemos proporcionar a nuestra solicitud firmada y, por último, debemos designar los grupos de respuesta que nos gustaría devolver. Hay 55 opciones en total, y varían en tamaño y tipo de datos devueltos. Para nuestros propósitos, estamos buscando el título completo de la película y la URL completa de la página de detalles, ambas pertenecientes al grupo de respuestas "Pequeñas". También necesitamos una imagen en miniatura del grupo de respuestas "Images" y el precio nuevo más bajo del grupo "OfferSummary".

La función fetch_product_data() es nuestro método públicamente expuesto que toma dos parámetros:

Una frase clave específica que se refiere al nombre del producto que queremos buscar
Una categoría de producto de Amazon aceptada

En última instancia, devolverá un conjunto de datos pertenecientes al primer resultado de búsqueda analizado desde una respuesta XML. (En muchos casos, el primer resultado será el producto que deseamos, suponiendo que la frase clave que suministramos sea lo suficientemente específica como alternativa, puede decidir modificar este ejemplo para buscar por el número ASIN o ID específico del producto En cambio, pero hay ventajas y desventajas de este método. Si usted tiene una gran base de datos de páginas de artículos para diferentes películas, utilizando un enfoque basado en nombres probablemente resultará más eficiente, ya que le permitirá generar automáticamente enlaces de productos para todos sus artículos al instante y ahorrarle tiempo extra y Esfuerzo de tener que buscar manualmente e insertar IDs para cada uno.)

Generación de una solicitud firmada

El siguiente paso es agregar una helper class que haga la solicitud firmada a la API del producto. Utilicé una función de terceros escrita por Ulrich Mierendorff y la envolvió en su propia clase estática llamada AWSSignedRequest. Se necesitan varios parámetros, incluyendo la región (para la tienda de los Estados Unidos, usamos "com"), un array de parámetros de solicitud, nuestras claves AWS, grupos de respuesta y la versión de la API que ya hemos definido. El método get_signed_request() esencialmente crea y devuelve una cadena de solicitud de URL completa de todas estas piezas.

La URL final de la solicitud firmada se verá así:

http://webservices.amazon.com/onca/xml?
        AWSAccessKeyId=AKIAJILHUTAJ5MMQRJWA
        &AssociateTag=envtut-20
        &Operation=ItemSearch
        &ResponseGroup=Small%2CImages%2COfferSummary
        &SearchIndex=Movies
        &Service=AWSECommerceService
        &Timestamp=2015-11-06T20%3A34%3A52Z
        &Title=Jurassic%20World
        &Version=2013-08-01
        &Signature=nwkfvvLCvl11Cunuthz6orXCbBMnBc1Z7S3HSfYW%2B14%3D

En la clase AmazonAssocHelper, coloque la llamada a get_signed_request() en un método llamado get_search_results() y pase una matriz que contenga cuatro parámetros de búsqueda ($params) junto con los otros argumentos como se muestra a continuación:

    /**
    * Runs search with signed request on product API using keyphrase and category name
	* returns: XML object
	*/
	private static function get_search_results($keyphrase, $search_index) {
		
		//Define the request
		$params = array("SearchIndex"=>$search_index, //the category
						"Title"=>$keyphrase, 
						"Operation"=>self::$operation,
						"ResponseGroup"=>self::$response_group);
		
		$request = AWSSignedRequest::get_signed_request('com', $params, self::AMZ_ASSOC_ACCESSKEY, self::AMZ_ASSOC_SECRETKEY, self::AMZ_ASSOC_TAG, self::$version);

		$response = file_get_contents($request);
        
        //for testing
        /*header('Content-type: application/xml');
    	echo $response;
		exit;*/
        
		return simplexml_load_string($response);
		
	}

Nuestra array $params incluye la operación y la respuesta que ya hemos definido, así como los valores de 'Title' y 'SearchIndex'. En este caso, SearchIndex es simplemente la categoría de producto en la que estamos buscando. Ahora, podemos invocar la función de file_get_contents() incorporada de PHP para generar una respuesta de la petición, y como la respuesta es un documento XML, usamos otra función incorporada, simplexml_load_string(), para cargarla como un objeto que nosotros podamos usar.

Prueba de la respuesta y previsualización de datos XML

En este punto, queremos poder probar nuestra solicitud de API con algunos valores reales de producto para que podamos ver un ejemplo real de lo que nuestros datos XML devueltos se ven antes de mostrarlos. Como se muestra arriba, agregue unas líneas de prueba para establecer el encabezado en application / XML e muestre $response antes de que se devuelva.

Ahora, cree un archivo que servirá como la página principal donde se mostrará el enlace del producto. He decidido llamarlo index.php. En la parte superior, agregue el siguiente código:

<?php

    namespace App\Services;

	require_once getcwd() . '/App/app_global.php';

	/**
	*	Call the Product API by passing in the name of the product and the shopping category
	*	("Books", "Movies", and "VideoGames" are examples -- see API documentation for full list)
	*/
	$product_data = AmazonAssocHelper::fetch_product_data("Jurassic World", "Movies");


?>

Las dos primeras líneas declaran nuestro espacio de nombres e incluyen una función global que permite que nuestros archivos de clase se auto-carguen, ya que no estamos usando un framework PHP. La siguiente línea es la importante. Llamamos al método público fetch_product_data() en nuestra clase AmazonAssocHelper y lo asignamos a una variable de matriz llamada $product_data, pasando un nombre de película específico como frase clave (elegi "Jurassic World" en la lista actual de best sellers) y "Películas" como la categoría.

Al cargar su página, el principio de su respuesta XML debería tener el siguiente aspecto:

<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2013-08-01">
<OperationRequest>
<RequestId>807ede04-f196-44a0-99ff-ff1bb1c12fee</RequestId>
<Arguments>
<Argument Name="AWSAccessKeyId" Value="AWS_ACCESS_KEY"/>
<Argument Name="AssociateTag" Value="envtut-20"/>
<Argument Name="Operation" Value="ItemSearch"/>
<Argument Name="ResponseGroup" Value="Small,Images,OfferSummary"/>
<Argument Name="SearchIndex" Value="Movies"/>
<Argument Name="Service" Value="AWSECommerceService"/>
<Argument Name="Timestamp" Value="2015-11-03T21:32:57Z"/>
<Argument Name="Title" Value="Jurassic World"/>
<Argument Name="Version" Value="2013-08-01"/>
<Argument Name="Signature" Value="QhUpga/f2MReU4xpdzCr432hMvxeA72N+v+G0hVi17M="/>
</Arguments>
<RequestProcessingTime>0.0887890000000000</RequestProcessingTime>
</OperationRequest>
<Items>
<Request>...</Request>
<TotalResults>37</TotalResults>
<TotalPages>4</TotalPages>
<MoreSearchResultsUrl>...</MoreSearchResultsUrl>
<Item>
<ASIN>B016W01EXI</ASIN>
<DetailPageURL>
http://www.amazon.com/Jurassic-World-Chris-Pratt/dp/B016W01EXI%3FSubscriptionId%3DAKIAJILHUTAJ5MMQRJWA%26tag%3Denvtut-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3DB016W01EXI
</DetailPageURL>
<ItemLinks>
<ItemLink>
<Description>Technical Details</Description>
<URL>
http://www.amazon.com/Jurassic-World-Chris-Pratt/dp/tech-data/B016W01EXI%3FSubscriptionId%3DAKIAJILHUTAJ5MMQRJWA%26tag%3Denvtut-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3DB016W01EXI
</URL>
</ItemLink>

Si se desplaza y escanea la salida, debería poder ver todos los datos que serán útiles para nuestra demo, incluyendo , <DetailPageURL> <Title> <LargeImage> <LowestNewPrice>. Estos son los nodos que nos centraremos en analizar.

Mostrar el objeto de respuesta

En la clase AmazonAssocHelper, cree otro método llamado get_top_result_data() que tome nuestro objeto de respuesta XML como parámetro. Ahora podemos empezar a leer los nodos que contienen los datos que queremos capturar, pero antes de ir allí, vamos a planificar la incorporación de algunos errores de verificación. He añadido un par de líneas en la parte superior de nuestra función para invocar un método que se encargará de analizar los nodos de error para nosotros, y lo repasaré con más detalle hacia el final de este tutorial.

    /**
    * Parses top result node, and its attributes, from XML object
	* returns: array of product data
	*/
	private static function get_top_result_data($xml) {

		if (!empty(self::handle_errors($xml))) {
			return array('error'=>self::handle_errors($xml));
		}

		//get the first result node
		$first_item = $xml->Items[0]->Item; 
		$item_title = $first_item->ItemAttributes->Title;
		$item_link = $first_item->DetailPageURL;
		$item_image = $first_item->LargeImage->URL;
		$item_price = $first_item->OfferSummary->LowestNewPrice->FormattedPrice;

		return array( 'title'=>(string)$item_title,
					  'link'=>(string)$item_link, 
					  'image'=>(string)$item_image, 
					  'price'=>(string)$item_price );

		

	}

Como se puede ver en el código anterior, comenzamos recuperando el primer nodo de elemento (Item[0]) del objeto XML y almacenándolo en una variable ($first_item). Luego, operamos en cada uno de sus hijos para recoger las piezas de información que queremos ($item_title, $item_link, $item_image, $item_price). Finalmente, lo empacamos todo en un array con atributos nombrados y devolvemos la array.

Manejo de errores

Cree un método denominado handle_errors() y pase el mismo objeto XML. En función de la configuración de esta API, se configuran múltiples nodos de error con códigos y mensajes específicos para que aparezcan en el nodo <OperationRequest> o en el nodo Items <Request> . Puede probarlos estableciendo un índice de búsqueda no válido o un grupo de respuestas. El siguiente código pasa a través de cada uno de los nodos y empuja los mensajes de error en un array que devolvemos:

/**
    * Checks for errors in the request/ result
	* returns: array with message(s) describing the "error"
	*/
	private static function handle_errors($xml) {

		$errors_arr = array();

		//process errors in request
		foreach ($xml->OperationRequest->Errors->Error as $error) {

		   	error_log("Error code: " . $error->Code . "\r\n");
		  	error_log($error->Message . "\r\n");
		  	error_log("\r\n");

		  	array_push($errors_arr, (string)$error->Message);
		}

		//check for invalid category, no matches, or other search error
		foreach ($xml->Items->Request->Errors->Error as $error) {
			
			error_log("Error code: " . $error->Code . "\r\n");
		  	error_log($error->Message . "\r\n");
		  	error_log("\r\n");

			array_push($errors_arr, (string)$error->Message);
		}
		

		return $errors_arr;

	}

Cómo rellenar los datos en una plantilla de HTML

En este punto, puede eliminar las llamadas de prueba XML, ya que estamos listos para ver la salida final de datos. En index.php, muestre la array $product_data devuelta y cargue la página. Debería ver algo como esto:

Array ( [title] => Jurassic World [link] => http://www.amazon.com/Jurassic-World-Chris-Pratt/dp/B016W01EXI%3FSubscriptionId%3DAKIAJILHUTAJ5MMQRJWA%26tag%3Denvtut-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3DB016W01EXI [image] => http://ecx.images-amazon.com/images/I/51ePeFXU2ML.jpg [price] => $5.99 )

Una vez que haya verificado que los datos parecen correctos para cada una de las cuatro propiedades que nos interesan, puede intentar ejecutar la llamada en otras películas o productos para comparación. Tenga en cuenta que el ID de afiliado (en este caso "envtut-20") se ha insertado automáticamente en el "vínculo" como debemos esperar.

Como último paso, programemos un simple bloque de HTML para mostrar nuestros datos de película y hacer que se vincule a la página de compra. En index.php, agregue lo siguiente debajo del bloque PHP:

<!doctype html>
<html>
    <head>
		<title>Tuts+ Demo: Amazon Product API</title>
        <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
		<link rel="stylesheet" href="css/reset.css" />
		<link rel="stylesheet" href="css/style.css" />
	</head>
	<body>
		<?php if (!empty($product_data) && array_key_exists("error", $product_data) != 1): ?>
			<div class="affiliate_wrap">
				
				<a href="<?php echo $product_data['link']; ?>" target="_blank">
					<img src="<?php echo $product_data['image']; ?>" alt="<?php echo $product_data['title']; ?>" />
				</a>
				<h2>
					<a href="<?php echo $product_data['link']; ?>" target="_blank"><?php echo $product_data['title']; ?></a>
				</h2>
				<p><em><?php echo $product_data['price']; ?></em> on Amazon</p>
				<a class="button" href="<?php echo $product_data['link']; ?>" target="_blank">Buy Now</a>
			</div>

		<?php endif ?>
	</body>
</html>

Tenga en cuenta que en caso de que se devuelva un error, he optado por ocultar la visualización en conjunto, pero alternativamente, podría mostrar el mensaje de error adecuado en su lugar.

Ahora, con estilos CSS añadidos, la salida final se vería algo como esto:

¡Y ahí lo tienes! Una vez que haya lanzado su módulo de afiliados en el mundo, puede realizar un seguimiento de todas las compras y ganancias al iniciar sesión en su cuenta.

Conclusion

En este tutorial, cubrimos todos los pasos necesarios para que un programador PHP construya una solución de código escalable que genere instantáneamente un vínculo de afiliado personalizado para virtualmente cualquier producto en la tienda de Amazon. Según sus necesidades o preferencias, puede decidir cambiar o ampliar este ejemplo con diferentes parámetros.

También puede explorar la documentación de la API con más detalle por su cuenta para descubrir aún más de lo que es posible. El verdadero poder en el uso de la Product Merchandising API reside en la flexibilidad que proporciona para organizar y mostrar una gama completa de información en tiempo real sobre un producto o una lista de productos. Con el generador de vínculos predeterminado de Amazon (no se requiere conocimientos de programacion), no obtiene casi la misma cantidad de control y sus opciones son limitadas.

La API realmente brilla en las páginas web que se generan dinámicamente y en las páginas donde se necesita un mayor nivel de control sobre la apariencia de sus enlaces, por lo que si está trabajando en un sitio web o blog a lo largo de estas líneas y buscando incorporar la monetización, espero que haya encontrado este tutorial útil.