MashupYourLife.de

Vorwort

Amazon stellt mit seiner API eine Schnittstelle zur Verfügung, mit der man sehr einfach auf alle vorhandenen Artikeldaten zugreifen kann. Diese API wird bevorzugt von Amazon-Partnern verwendet, die von Amazon eine Provision für jeden über sie verkauften Artikel erhalten. So hat jeder was von der API: Amazon und Ihre Partner.

Doch genug der Einführung, worum geht es hier genau?

Amazon hat in den letzten Tagen per E-Mail eine Umbenennung der API bekannt gegeben. Die API lief bisher unter dem Namen "Amazon Associates Web Service" und wird ab jetzt "Product Advertising API" genannt. Dies soll stärker zum Ausdruck bringen, dass diese API zum Bewerben von Amazon-Artikeln dienen soll. Um diesen Zweck noch ein mal Nachdruck zu verleihen, wird auch für die Verwendung der API die Authentifizierung über eine Signatur eingeführt. D.h. ohne einen gültigen Schlüssel ist die Verwendung der API nicht mehr möglich.

Für diese Änderungen gibt es eine Übergangsphase vom 11.05.2009 bis zum 15.08.2009. Ab dem 15.08.2009 sind Daten ohne gültige Signatur über die API nicht mehr abrufbar. Diese Übergangsphase ist insofern wichtig, da alle bisherigen Mashups bzw. Anwendungen, die diese API verwenden angepasst werden müssen. In diesem Tutorial sollen die notwendigen neuen Schritte zum Erhalt der benötigten Daten ein bisschen näher durchleuchtet werden, so dass der Schritt zu einer weiterhin funktionierenden Amazon-Anwendung vereinfacht werden soll. Vorab möchte ich mich bei Ulrich Mierendorff bedanken, der auf seiner Seite eine mögliche Umsetzung des signierten Abrufs von Daten über die Amazon-API in PHP vorstellt. Hier soll das Ganze nochmal auf deutsch ein bisschen genauer beschrieben werden.

Voraussetzungen

• PHP Grundlagenwissen
• HTML Grundlagenwissen

Vorbereitungen

• Es wird ein AWS-Account (AWS = Amazon Web Services) benötigt, der für die Verwendung der Product Advertising API kostenlos ist.
• Mit diesem AWS-Account kann hier ein Zugangsschlüssel-Paar generiert werden.

Ein bisschen Theorie vorab

Amazon beschreibt in der Dokumentation welche Schritte für einen signierten Aufruf notwendig sind:

• Ein "kanonisierter", also ein normalisierter Abfrage-String muss erstellt werden. Dieser muss:
  • die Parameter alphabetisch sortiert haben
  • die Parameter und die entsprechenden Werte nach bestimmten Regeln codiert haben
  • die Parameter und die entsprechenden Werte jeweils durch ein Gleichheitszeichen ("=") getrennt haben
  • die Parameter-Wert-Paare durch ein kaufmännisches Und ("&") getrennt haben
• Dieser Abfrage-String wird in Verbindung mit der Abruf-Methode, des Hosts und der URI zu einem Gesamt-Abfrage-String zusammengesetzt.
• Dieser Gesamt-Abfrage-String wird mit SHA256 und dem Zugangsschlüssel verschlüsselt.
• Der verschlüsselte String muss mit Base64 kodiert werden.
• Das Ergebnis wird als Wert für den Parameter "Signature" an die bisher gewohnt Abruf-URL angehangen.

Das klingt alles sehr theoretisch. Diese Beschreibung hilft aber beim Verständnis des ganzen Vorgehens hier.

Jetzt wird es interessant: Die Praxis

Wie schon erwähnt, hat Ulrich Mierendorff eine sehr schöne Funktion entwickelt, die genau diese gerade beschriebenen Schritte durchführt. Die vollständige Funktion findet Ihr hier. Nachfolgend eine kurze Beschreibung dieser Funktion anhand eines praktischen Beispiel.

Das Beispiel

Die Umsetzung

Zunächst einmal definieren wir ein paar Variablen:

$method = "GET";
$host = "ecs.amazonaws.de";
$uri = "/onca/xml";
$public_key = "XXXXXX";
$private_key = "YYYYYY";

"XXXXXX" und "YYYYYY" müsst Ihr natürlich mit Euren Zugangsschlüsseln ersetzen. Jetzt werden die Parameter für die Abfrage definiert:

$params["Service"] = "AWSECommerceService";
$params["AWSAccessKeyId"] = $public_key;
// GMT timestamp
$params["Timestamp"] = gmdate("Y-m-d\TH:i:s\Z");
// API version
$params["Version"] = "2009-03-31";
$params["Operation"] = "ItemLookup";
$params["ResponseGroup"] = "Large";
$params["ItemId"] = "3836401126";

Diese Parameter müssen nun sortiert werden:

ksort($params);

Den normalisierten String erhalten wir mit folgender Schleife:

$canonicalized_query = array();
foreach ($params as $param=>$value) {
  $param = str_replace("%7E", "~", rawurlencode($param));
  $value = str_replace("%7E", "~", rawurlencode($value));
  $canonicalized_query[] = $param."=".$value;
}
$canonicalized_query = implode("&", $canonicalized_query);

Der zu verschlüsselnde String wird jetzt zusammengesetzt, verschlüsselt und kodiert:

$string_to_sign = $method."\n".$host."\n".$uri."\n".$canonicalized_query;
$signature = base64_encode(hash_hmac("sha256", $string_to_sign, $private_key, true));
$signature = str_replace("%7E", "~", rawurlencode($signature));

Diese verschlüsselte String wird nun als Parameter an die Abfrage gehangen:

$request = "http://".$host.$uri."?".$canonicalized_query."&Signature=".$signature;

Mit Hilfe dieses String können die Daten nun abgerufen werden:

//XML-Datei abrufen
$xmlItemResult = simplexml_load_file($request);
//Titel abrufen
$myTitle = $xmlItemResult->Items->Item->ItemAttributes->Title;
//Daten zum Bild abrufen
$myImage = $xmlItemResult->Items->Item->MediumImage->URL;

Mit den erhaltenen Daten können wir nun unsere Ausgabe formen:

echo "<img src='".$myImage."' title='".$myTitle."' />";

Was dann so aussehen sollte:

Das vollständige Skript findet Ihr als vorgefertigte Funktion hier.

Vorteile

Nachteile

Durch die Einführung der Signatur für die Verwendung der API ergibt sich das Problem, dass bestimmte Arten von Anwendungen nicht mehr verteilt werden können. So ist es z.B. nicht mehr so einfach möglich ein Open-Source-Script zu entwickeln und zur freien Verwendung freizugeben, da jeder, der er benutzen möchte, noch zusätzlich einen AWS-Account beantragen muss. Eine etwas extremerer Fall ist z.B. die Programmierung einer Extension für Firefox. Da Amazon es nicht erlaubt den Zugangsschlüssel öffentlich bekannt zu machen, ist die Programmierung einer solchen Extension überhaupt nicht mehr möglich, da die Hürden (sich bei AWS anzumelden) für einen "normalen" Endanwender zu hoch sind.

Links

• Offizielle Dokumentation von Amazon
• Umsetzung von Ulrich Mierendorff als Funktion in PHP
• Suchen in Amazon ohne MarketPlace (Umsetzung im Einsatz)