Erstellen Sie einen benutzerdefinierten Partner-Link mit der Amazon Product Merchandising API

() translation by (you can also view the original English article)

Das Amazon Associates-Programm bietet Entwicklern in Verbindung mit Amazon Web Services (AWS) eine leistungsstarke Möglichkeit, den Amazon Store-Katalog mithilfe einer RESTful-API zu durchsuchen und Daten für praktisch alle Produktlisten in eine Webseite zu integrieren. Wenn Sie ein Programmierer mit einer geschäftlichen Einstellung sind und nach Möglichkeiten suchen, Ihre Website zu monetarisieren, können Sie sich als Amazon-Partner anmelden und eine Provision erhalten, wenn ein Nutzer auf Ihren Produkt-Link klickt und einen Kauf abschließt. (Und was Partnerprogramme angeht, gehören die Provisionen von Amazon zu den großzügigsten.)

Nehmen wir an, Sie betreiben einen Blog oder eine Website mit Filmkritiken. Für jeden veröffentlichten Filmbericht können Sie davon profitieren, indem Sie einen Link für den Leser angeben, um den Film in der Nähe Ihres Artikels zu kaufen. Um das Klicken attraktiver zu gestalten, kann der Link ein Miniaturbild der DVD, den vollständigen Namen des Films, den niedrigsten verfügbaren Preis und eine Schaltfläche "Kaufen" enthalten.

In diesem Tutorial zeige ich Ihnen, wie Sie eine dedizierte, wiederverwendbare Klasse in PHP erstellen, die eine Verbindung zur Product Merchandising API herstellt und XML-Daten basierend auf dem Namen des Produkts und der Einkaufskategorie (in diesem Fall "Movies") abruft. Am Ende füllen wir diese Daten in eine kleine, vollständig anpassbare HTML-Vorlage, so dass wir eine funktionierende Demo eines Mini-Affiliate-Moduls erhalten. Lass uns anfangen.

[Bitte beachten Sie vor dem Aufrufen der Beispieldemo, dass die Zahlung einer Provision an Envato Tuts + erfolgt, wenn Sie sich entscheiden, die DVD über den angegebenen Link zu kaufen oder zu mieten.]

Registrierung für eine Partner-ID und Abrufen von Anmeldeinformationen

Eröffnen Sie zunächst ein Konto bei affiliate-program.amazon.com. Es ist kostenlos und Sie müssen nur die Schritte befolgen, um ein Profil für Ihre Website zu erstellen. Sie werden aufgefordert, Ihre Identität am Ende des Vorgangs zu bestätigen, indem Sie Ihre Telefonnummer eingeben, einen automatisierten Anruf erhalten und den Passcode eingeben, den Sie erhalten haben.

Wenn Sie die Registrierung abgeschlossen haben, erhalten Sie eine Amazon-Partner-ID (in diesem Beispiel "envtuts-20"). Melden Sie sich mit Ihrem Benutzernamen und Kennwort in Ihrem Hauptkonto-Bereich an und klicken Sie auf die Registerkarte Product Merchandising API. Klicken Sie dort auf den Link, um die API zu verwenden.

Sie müssen sich bei Amazon Web Services (aws.amazon.com) anmelden, sofern Sie dies noch nicht getan haben. In der AWS-Konsole können Sie unter Sicherheitsberechtigungsnachweise einen Zugriffsschlüssel und einen geheimen Schlüssel zum Erstellen von API-Anforderungen generieren. (Hinweis: Es ist wichtig, dass diese Anmeldeinformationen privat und sicher bleiben. Niemals öffentlich auf GitHub oder sonstwo online verfügbar machen.)

Einrichten unserer PHP Helper-Klasse

Zum Zwecke dieses Beispiels und um die Dinge relativ einfach zu halten, implementieren wir das Singleton-Entwurfsmuster, um eine statische Hilfsklasse namens AmazonAssocHelper zu erstellen. Sie enthält eine öffentliche Methode, die eine Verbindung zur API herstellt, den Katalog durchsucht und Produktdaten mithilfe bestimmter Parameter zurückgibt, die wir übergeben. So habe ich es eingerichtet:

<?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);
	
	}


}

Die ersten paar Zeilen deklarieren einen Namespace für unsere Klasse und enthalten eine Klasse eines Drittanbieters, die wir benötigen, um mit unseren Anmeldeinformationen eine signierte Anforderung an die API zu stellen. Die drei Konstanten, die ich definiert habe, sind unsere wichtige Partner-ID, die wir nach der Anmeldung erhalten haben, sowie den AWS-Zugriffsschlüssel und den geheimen Schlüssel. Wenn wir unsere API-Anfragen stellen, wird die Partner-ID automatisch in den Produktlink eingefügt, den wir abrufen, damit Einkäufe auf unser Konto zurückverfolgt werden können und wir bezahlt werden! Stellen Sie sicher, dass Sie alle drei Werte für sich selbst ausfüllen.

Die drei privaten Variablen beziehen sich auf Suchparameter, die wir für jede Anfrage angeben. Ich benutze "ItemSearch" als unsere Operationswahl, um Ergebnisse nachzuschlagen. "2013-08-01" ist das Datum der neuesten API-Version, die wir auch für unsere signierte Anfrage bereitstellen müssen, und schließlich müssen wir angeben, welche Antwortgruppen wir zurückgeben möchten. Es gibt insgesamt 55 Auswahlmöglichkeiten, die sich in Größe und Art der zurückgegebenen Daten unterscheiden. Für unsere Zwecke suchen wir nach dem vollständigen Titel des Films und der vollständigen URL für die Detailseite. Beide befinden sich in der Antwortgruppe "Klein". Wir benötigen auch ein Miniaturbild aus der Antwortgruppe "Bilder" und den niedrigsten neuen Preis aus der Gruppe "AngebotZusammenfassung".

Die Funktion fetch_product_data() ist unsere öffentlich zugängliche Methode, die zwei Parameter verwendet:

eine bestimmte Schlüsselphrase, die sich auf den Namen des Produkts bezieht, nach dem gesucht werden soll
eine akzeptierte Amazon-Produktkategorie

Am Ende wird ein Array von Daten zurückgegeben, das sich auf das aus einer XML-Antwort analysierte erste Suchergebnis bezieht. (In vielen Fällen ist das erste Ergebnis das gewünschte Produkt, vorausgesetzt, der von uns gelieferte Schlüsselsatz ist ausreichend.) Alternativ können Sie dieses Beispiel so ändern, dass es nach der spezifischen ASIN- oder ID-Nummer des Produkts sucht Stattdessen gibt es für diese Methode Vor- und Nachteile. Wenn Sie über eine umfangreiche Datenbank mit Artikelseiten für verschiedene Filme verfügen, ist die Verwendung eines namenbasierten Ansatzes höchstwahrscheinlich effizienter, da Sie damit automatisch Produktverknüpfungen für alle Ihre Artikel automatisch generieren können Mühe, IDs manuell suchen und einfügen zu müssen.)

Eine signierte Anfrage erstellen

Im nächsten Schritt fügen Sie eine Hilfsklasse hinzu, die die signierte Anforderung an die Produkt-API sendet. Ich habe eine von Ulrich Mierendorff geschriebene Funktion eines Drittanbieters verwendet und in eine eigene statische Klasse namens AWSSignedRequest verpackt. Dazu sind mehrere Parameter erforderlich, darunter die Region (für den US-Store verwenden wir "com"), ein Array von Anforderungsparametern, unsere AWS-Schlüssel, Antwortgruppen und die bereits definierte API-Version. Die get_signed_request() -Methode erstellt im Wesentlichen eine vollständige URL-Anforderungszeichenfolge aus allen diesen Teilen.

Die endgültige signierte Anforderungs-URL sieht folgendermaßen aus:

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

Platzieren Sie in der AmazonAssocHelper-Klasse den Aufruf von get_signed_request () in einer Methode mit dem Namen get_search_results (), und übergeben Sie ein Array mit vier Suchparametern ($params) und den anderen Argumenten wie folgt:

    /**
    * 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);
		
	}

Unser $params-Array enthält die Operation und die Antwort, die wir bereits definiert haben, sowie Werte für 'Title' und 'SearchIndex'. In diesem Fall ist der SearchIndex einfach die Produktkategorie, nach der wir suchen. Jetzt können wir die integrierte file_get_contents()- Funktion von PHP aufrufen, um eine Antwort aus der Anforderung zu generieren. Da es sich bei der Antwort um ein XML-Dokument handelt, verwenden wir eine andere integrierte Funktion, simplexml_load_string(), um sie als ein von uns geladenes Objekt zu laden kann analysieren.

Antwort testen und XML-Daten in der Vorschau anzeigen

An dieser Stelle möchten wir unsere API-Anfrage mit einigen echten Produktwerten ausprobieren können, damit wir ein Beispiel sehen können, wie unsere zurückgegebenen XML-Daten aussehen, bevor sie analysiert werden. Fügen Sie wie oben gezeigt einige Testzeilen hinzu, um den Header auf application / XML zu setzen, und drucken Sie die $response aus, bevor sie zurückgegeben wird.

Erstellen Sie nun eine Datei, die als Hauptseite dient, auf der der Produktlink angezeigt wird. Ich habe mich entschieden, es index.php zu nennen. Fügen Sie oben den folgenden Code ein:

<?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");


?>

Die ersten beiden Zeilen deklarieren unseren Namespace und enthalten eine globale Funktion, mit der unsere Klassendateien automatisch geladen werden können, da wir kein PHP-Framework verwenden. Die nächste Zeile ist die wichtige. Wir rufen die öffentliche Methode fetch_product_data() in unserer AmazonAssocHelper-Klasse auf und ordnen sie einer Array-Variablen mit dem Namen $product_data zu. Dabei übergeben wir einen bestimmten Filmnamen als Schlüsselphrase (Ich habe "Jurassic World" aus der aktuellen Liste der Bestseller gewählt) und "Filme" als Kategorie.

Wenn Sie Ihre Seite laden, sollte der Anfang Ihrer XML-Antwort folgendermaßen aussehen:

<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>

Wenn Sie die Ausgabe scrollen und scannen, sollten Sie in der Lage sein, alle Daten zu sehen, die für unsere Demo nützlich sind, einschließlich <DetailPageURL>,<Title>,<LargeImage>und<LowestNewPrice>,<LargeImage>und<LowestNewPrice>.Es gibt die Knoten, auf die wir uns beim Parsen konzentrieren werden., <LargeImage> und <LowestNewPrice>. Es gibt die Knoten, auf die wir uns beim Parsen konzentrieren werden.

Parsen des Antwortobjekts

Erstellen Sie in der AmazonAssocHelper-Klasse eine andere Methode namens get_top_result_data(), die unser XML-Antwortobjekt als Parameter verwendet. Wir können jetzt mit dem Lesen der Knoten beginnen, die die Daten enthalten, die wir erfassen möchten. Bevor wir jedoch dorthin gehen, wollen wir einige Fehlerprüfungen einplanen. Ich habe am Anfang unserer Funktion ein paar Zeilen hinzugefügt, um eine Methode aufzurufen, die das Parsen von Error-Knoten für uns übernimmt.

    /**
    * 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 );

		

	}

Wie Sie im obigen Code sehen können, rufen wir zunächst den ersten Elementknoten (Item[0]) aus dem XML-Objekt ab und speichern ihn in einer Variablen ($first_item). Anschließend führen wir für jedes seiner untergeordneten Elemente die erforderlichen Informationen aus ($item_title, $item_link, $item_image, $item_price). Zum Schluss packen wir alles in ein Array mit benannten Attributen und geben das Array zurück.

Fehler behandeln

Erstellen Sie eine Methode namens handle_errors() und übergeben Sie dasselbe XML-Objekt. Je nachdem, wie diese API eingerichtet ist, werden mehrere Fehlerknoten mit bestimmten Codes und Meldungen so eingestellt, dass sie entweder im<OoerationRequest>-Knoten oder im Items<Request>-Knoten erscheinen. Sie können dies testen, indem Sie einen ungültigen Suchindex oder eine Antwortgruppe festlegen. Der folgende Code durchläuft jeden Knoten und schiebt die Fehlermeldungen in ein Array, das wir zurückgeben:

/**
    * 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;

	}

Füllen der Daten in einer HTML-Vorlage

An diesem Punkt können Sie die XML-Testaufrufe entfernen, da wir die endgültige Datenausgabe betrachten können. Drucken Sie in index.php das zurückgegebene $product_data array und laden Sie die Seite. Sie sollten so etwas sehen:

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 )

Wenn Sie sich vergewissert haben, dass die Daten für jede der vier Eigenschaften, an denen wir interessiert sind, richtig aussehen, können Sie den Anruf für andere Filme oder Produkte zum Vergleich ausführen. Beachten Sie, dass die Partner-ID (in diesem Fall "envtut-20") wie erwartet automatisch in den Link eingefügt wurde.

Als letzten Schritt kodieren wir einen einfachen HTML-Block, um unsere Filmdaten anzuzeigen und mit der Kaufseite zu verknüpfen. Fügen Sie in der Datei index.php unter dem PHP-Block Folgendes hinzu:

<!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>

Beachten Sie, dass ich mich im Falle einer Fehlermeldung dafür entschieden habe, die Anzeige vollständig auszublenden. Alternativ können Sie stattdessen die entsprechende Fehlermeldung anzeigen.

Wenn nun CSS-Stile hinzugefügt werden, sieht die endgültige Ausgabe etwa so aus:

Und da hast du es! Sobald Sie Ihr Affiliate-Modul in der Welt eingeführt haben, können Sie alle Einkäufe und Einnahmen nachverfolgen, indem Sie sich bei Ihrem Konto anmelden.

Fazit

In diesem Tutorial haben wir alle Schritte beschrieben, die ein PHP-Programmierer benötigt, um eine skalierbare Codelösung zu erstellen, die sofort einen benutzerdefinierten Partner-Link für praktisch jedes Produkt im Amazon Store generiert. Je nach Ihren Bedürfnissen oder Vorlieben können Sie dieses Beispiel mit anderen Parametern ändern oder erweitern.

Sie können auch die API-Dokumentation selbst ausführlicher untersuchen, um noch mehr Möglichkeiten zu entdecken. Die wirkliche Kraft bei der Verwendung der Product Merchandising-API liegt in der Flexibilität, die sie bietet, um eine vollständige Palette von Echtzeitinformationen zu einem Produkt oder einer Liste von Produkten zu erstellen und anzuzeigen. Mit dem Standard-Link-Generator von Amazon (keine Codierkenntnisse erforderlich) erhalten Sie nicht annähernd dieselbe Kontrolle und Ihre Optionen sind begrenzt.

Die API zeigt sich wirklich auf Webseiten, die dynamisch generiert werden, und auf Seiten, auf denen Sie mehr Kontrolle über das Erscheinungsbild Ihrer Links benötigen. Wenn Sie also an einer Website oder einem Blog in dieser Hinsicht arbeiten und eine Monetarisierung wünschen, hoffe ich dass Sie dieses Tutorial nützlich gefunden haben.