Das eBay API Test Tool

Die eBay API ist ein komplexes System, über das Sie Daten direkt von den eBay-Servern abrufen können. Im Gegensatz hierzu ist ein Feed eine eigenständige Datei, die Verweise auf Artikel bei eBay enthält. Auf der Website des eBay Developer Programms finden Sie ein komplexes API-Test-Tool, mit dem die Ergebnisse von API-Calls unter Verwendung aller verfügbarer Parameter überprüft werden können. Mit diesem Tool können Developer oder Affiliates individuelle API-Calls testen, bevor sie auf der Website integriert werden. Weitere ausführliche Informationen zur API finden Sie hier.

API-Calls erstellen

Links im Tool können Sie durch Festlegen einiger Optionen den API-Call und dessen Ziel bestimmen. Im Folgenden wird jeder Abschnitt näher erläutert:

Sandbox/Production

Die Sandbox verwendet Testdatenbanken, die keine tatsächlich eingestellten Artikel und Daten enthalten. Die Production-Umgebung verwendet Live-Datenbanken, die aktuell bei eBay eingestellte Artikel enthalten. Verwenden Sie die Sandbox zum Testen von Aufrufen, über die Artikel bei eBay eingestellt werden, wie in der Trading-API. Nach diesem Test kann dann zur Production-Umgebung gewechselt werden. Diese Umgebung verwenden Sie zum Extrahieren von Informationen, z.B. zum Suchen von Artikeln, Kategorien und Verkäufern.

Key Set

Die Felder in diesem Abschnitt werden automatisch ausgefüllt, sobald Sie in Ihrem Developer Konto Ihre Developer Keys eingerichtet haben.

API auswählen

Es sind verschiedene APIs verfügbar, die unterschiedliche Funktionen haben. Die Finding- und Shopping-APIs dienen zum Suchen nach verfügbaren Artikeln. Die Trading-API dient zum Einstellen und Verkaufen von Artikeln. Ausführliche Informationen zu den Funktionen der einzelnen APIs finden Sie im Documentation Center. In diesem Artikel gehen wir insbesondere auf die  Verwendung der Finding-API ein.

API-Call auswählen

Für jede API stehen verschiedene Calls zur Verfügung. So ist beispielsweise der hilfreichste und gängigste Call in der Finding-API der findItemsAdvanced-Call, der die größte Flexibilität beim Suchen von Artikeln bietet. In der Finding-API sind jedoch auch andere Calls verfügbar, z.B. Calls zum Suchen von Artikeln nach Kategorie oder Shop-Name. Auch hier finden Sie ausführliche Informationen zu den Funktionen der einzelnen Calls im Documentation Center.

Vorlage auswählen

Nachdem Sie den Aufruftyp ausgewählt haben, können Sie die Suchkriterien des erstellten Calls ändern. So können Sie schnell einige Beispielfelder für Suchkriterien in das Anforderungsfeld rechts einfügen. Diese können jederzeit geändert oder entfernt werden. Wenn Sie „Full/Generic“ wählen, werden im Feld „XML Request“ leere Felder eingefügt. Wenn Sie „Partial/Pre-Filled“ wählen, werden einige grundlegende Beispielfelder eingefügt, die bereits Werte enthalten. Dies ist hilfreich, wenn Sie mit dem Tool noch nicht vertraut sind, da Sie so zunächst die Suchfunktionen näher kennenlernen. Wenn Sie ein Beispiel sehen möchten, das die ePN Tracking-Parameter enthält, wählen Sie die Option „Full/generic“. Die Parameter werden dann in den <affiliate>-Tags angezeigt.

Aufrufvariante/Zu verwendende Felder auswählen

Der Inhalt von „Fields to Include“ wird von der von Ihnen ausgewählten Vorlage bestimmt. Auch das ist eine schnelle Methode, um Ihrem „XML Request“ Suchfelder hinzuzufügen. Bei Auswahl der Vorlage „Full/Generic“ haben Sie die Möglichkeit, lediglich erforderliche Felder oder aber alle möglichen Felder hinzuzufügen. Wenn Sie alle möglichen Felder hinzufügen möchten, werden diese im Feld „XML Request“ auf der rechten Seite hinzugefügt. Hier können Sie jedes einzelne Feld durchgehen und entscheiden, ob es verwendet werden soll. So möchten Sie beispielsweise nach Keywords suchen, aber benötigen keine Kategorie. In diesem Fall können Sie in die Zeile „<keywords>string</keywords>“ Ihre Keywords nach Bedarf einfügen. Löschen Sie anschließend die Zeile „<categoryId>string</categoryId>“ aus dem Feld. Wenn Sie mit allen möglichen Feldern auf diese Weise arbeiten, können Sie sich alle Möglichkeiten anzeigen lassen und einen bestimmten API-Call im vollen Umfang nutzen.

Call Request Version auswählen

In der Regel muss die Version nicht geändert werden. Eine Änderung ist nur in ganz bestimmten Situationen erforderlich, beispielsweise, wenn eine API geändert wurde und aufgrund dessen Probleme aufgetreten sind.

Website-ID auswählen

Verschiedene eBay-Websites dienen verschiedenen Zwecken, z.B. Websites für unterschiedliche Länder oder eBay Motors in den USA. Artikel, die in Großbritannien eingestellt werden, befinden sich auf der britischen Website und in Deutschland eingestellte Artikel auf der deutschen Website. Die verschiedenen Websites weisen verschiedene sprach- und länderspezifische Kategorien auf. Ein API-call kann nur an eine einzige eBay-Website gesendet werden. Diese muss daher angegeben werden. Wenn Sie für mehrere Websites einen Aufruf durchführen möchten, sind mehrere API-Calls erforderlich.

Anforderungswerte festlegen

Sobald Sie im Tool den gewünschten API-Call erstellt haben, können Sie auf der rechten Seite des Tools die Anforderungswerte des Calls ändern. Im Folgenden werden die einzelnen Abschnitte beschrieben:

Web Service URI (Endpoint)

Hierbei handelt es sich um die Web-URL der verwendeten API. Diese wird automatisch eingefügt, wenn Sie unter „Select an API“ eine API auswählen. Bei Bedarf können Sie die Adresse jedoch auch manuell ändern.

HTTP Headers

Auch dieses Feld wird automatisch anhand der Optionen ausgefüllt, die Sie beim Erstellen der API auf der linken Seite des Tools ausgewählt haben. Sie können das Feld manuell bearbeiten, es ist allerdings nicht unbedingt notwendig.

XML Request

Dieses Feld enthält die Daten, die an die API gesendet werden und diejenigen, die die auszugebenden Werte bestimmen. Die Suchparameter befinden sich zwischen XML-Tags: <entriesPerPage>2</entriesPerPage>. Zum Senden eines Calls ändern Sie die Werte zwischen den Tags (in diesem Fall „2“). Es ist hilfreich, die vorausgefüllten Beispiele zu verwenden, wenn Sie sich mit dem Bereich des Tools zunächst noch vertraut machen möchten. Eine vollständige Dokumentation zu jedem Parameter finden Sie im Documentation Center.

Ergebnisse anzeigen

Nachdem Sie alle Parameter ausgewählt haben, senden Sie die Anfrage. Ihre Ergebnisse werden dann im Feld „Call Response“ angezeigt. Die Ergebnisse werden im XML-Format dargestellt. Die Seite wird dann in etwa wie folgt aussehen:

Sollten keine Ergebnisse angezeigt werden, verwenden Sie einen allgemeineren Call. Wenn Sie mit dem Call zufrieden sind, können Sie ihn nun in eine Website integrieren.

Verwendungsbeispiel

Im Folgenden finden Sie ein Beispiel für die Verwendung des API-Tools mit dem Ziel, eine Liste mit blauen Shorts, die sofort in Großbritannien gekauft werden können, auszugeben.

1. Wählen Sie die Umgebung „Production“, da wir nach Artikeln suchen, die bei eBay eingestellt sind.

2. Wählen Sie die Finding-API, da wir nach Artikeln suchen.

3. Verwenden Sie den findItemsAdvanced-Call, damit erweiterte Parameter zum Suchen eines bestimmten Artikeltyps angegeben werden können.

4. Wählen Sie die Vorlage „Full, generic“ und fügen Sie alle zur Auswahl stehenden Felder in den Call ein. So können wir alle benötigten Parameter verwenden und die nicht benötigten Parameter entfernen.

5. Legen Sie für die Website-ID das Land (z.B. UK oder DE) fest.

6.  Legen Sie als Kategorie „Shorts“ fest. Auf der eBay-Kategorieseite finden Sie die benötigte Kategorie-ID. Auch das CGMlab-Kategorietool stellt Details zu jeder verfügbaren Kategorie bereit.

7.  Legen Sie Artikelfilter fest, um Auktionsangebote mit Sofort-Kaufen-Option, Festpreisartikel und eBay Shop-Artikel mit einzuschließen. Alle diese Artikel können sofort gekauft werden. Eine vollständige Liste für findItemsAdvanced verfügbare Artikelfilter finden Sie auf dem eBay-Developer Portal.

8. Legen Sie einen Aspektfilter fest, sodass nur Artikel, die als Hauptfarbe blau aufweisen, gesucht werden. Die möglichen Aspekte in einer bestimmten Kategorie finden Sie auf der jeweiligen Kategorieseite, in diesem Beispiel hier. Weitere Informationen zu Aspektfiltern finden Sie in der Call-Dokumentation.

9. Geben Sie Ihre ePN Tracking-Parameter an. Die Netzwerk-ID für das eBay Partner Network ist 9. Verwenden Sie außerdem das Tracking-ID-Tag für Ihre Kampagnen-ID. Das <geoTargeting>-Tag ist für die zukünftige Verwendung vorgesehen. Sie können den Wert auf 0 setzen.

10. Löschen Sie aus dem Feld „XML Request“ alle nicht verwendeten Felder. Da in diesem Beispiel zuvor alle möglichen Felder ausgewählt wurden, damit alle gewünschten Parameter einfacher hinzugefügt werden können, gibt es viele leere, nicht verwendete Felder. Diese leeren Felder können sich auf die Ergebnisse auswirken und müssen daher gelöscht werden. Der endgültige Call sieht dann ungefähr wie folgt aus:

11. Nach dem Senden des Aufrufs werden die Ergebnisse ausgegeben. Unter „Call Response“ finden Sie alle Details zum Call und den ausgegebenen Artikeln. Auch Fehlermeldungen werden hier angezeigt, sollte der Call fehlschlagen. In diesem Feld können Sie Parameter für den Call ändern, diesen erneut senden und ausprobieren, wie die besten Ergebnisse erzielt werden.

 

Implementierungsoptionen

Das API Test Tool ist ideal, um API-Calls anzuzeigen und alle Optionen auszuprobieren, bis der Call Ihren Vorstellungen entspricht. Sie haben viele verschiedene Möglichkeiten, wie Sie dann den API-Call tatsächlich implementieren. Ebenso stehen mehrere Formate für den Call an sich zur Verfügung. Beispiele für Finding-API-Calls für das XML- und Standard-URL-Format finden Sie hier.

Allgemeinere Informationen zu allen Optionen für Anforderungs- und Antwortformate finden Sie hier.