Nutzung von REST Clients für Allyouneed Marktplatz

Transkript

1 Nutzung von REST Clients für Allyouneed Marktplatz Stand: 23. Mai 2014 Version 1.0 portal.allyouneed.com

2 Inhaltsverzeichnis 1 Einführung Voraussetzungen crest Client für Google Chrome Installation des crest Client Nutzung des crest Client REST Client für Mozilla Firefox Nutzung des RESTClient Kontakt portal.allyouneed.com Seite 2

3 1 Einführung Willkommen beim DHL Web Service zur Produktpflege bei Allyouneed.com, dem Onlineshopping-Marktplatz von DHL. Dieses Dokument dient zur Unterstützung der API-Entwicklung für die Händler bei Allyouneed. Es wird beschrieben, wie die API durch einfache Nutzung eines REST Client getestet und verwendet werden kann. Es wird jeweils ein Client für Mozilla Firefox und für Google Chrome beschrieben. Alle detaillierten Beschreibungen und XML-Beispiele zur API sind den entsprechenden Dokumenten zu entnehmen, diese finden Sie im Downloadbereich: Voraussetzungen Für die Nutzung der Schnittstelle müssen Sie sich gegenüber Allyouneed authentifizieren. Dazu benötigen Sie Username Passwort und die URL zur Test- oder Live-Umgebung Test: Live: portal.allyouneed.com Seite 3

4 2 crest Client für Google Chrome 2.1 Installation des crest Client Für die Installation des crest Client muss der folgende Link aufgerufen werden: ce=chrome-ntp-icon Danach erscheint folgende Seite und durch den Button Hinzufügen wird die Installation gestartet. portal.allyouneed.com Seite 4

5 Die Installation muss bestätigt werden: 2.2 Nutzung des crest Client Nach der Installation des crest Client lässt sich dieser im Browser aufrufen: Damit erscheint folgende Eingabemaske: portal.allyouneed.com Seite 5

6 Die Nutzung des crest Client für die API bei Allyouneed wird nun in den folgenden Schritten beschrieben: Setzen der Methode auf POST Eingabe der URL für den gewünschten Server URL zur Testumgebung: Nun kann die XML-Datei für den gewünschten Request in die Request Entity kopiert werden portal.allyouneed.com Seite 6

7 Sind die Informationen vollständig kann der Request über den Button Request abgeschickt werden. Der Status der Datenübermittlung erscheint unter dem Tab Responses. Wurden die Daten korrekt und erfolgreich übermittelt ist der Status Code 200. Auf jeden korrekten Request gibt es eine inhaltliche Rückmeldung mit dem Status der hochgeladenen Daten. portal.allyouneed.com Seite 7

8 3 REST Client für Mozilla Firefox Für die Installation des RESTClient muss der folgende Link aufgerufen werden: Danach erscheint folgende Seite und durch den Button Zu Firefox hinzufügen wird das Add-on installiert. Die aktuelle Version ist mit deutschen Umlauten inkompatibel, deswegen empfehlen wir Ihnen die Version Die Installation wird wie folgt bestätigt: Bitte beachten Sie, dass im Anschluss ein Neustart von Firefox notwendig ist! portal.allyouneed.com Seite 8

9 3.1 Nutzung des RESTClient Nach Installation des RESTClient lässt sich dieser im Browser-Menü unter Extras aufrufen: Damit erscheint folgende Eingabemaske: Die Nutzung dieses RESTClient für die API zu Allyouneed wird nun in den folgenden Schritten beschrieben: portal.allyouneed.com Seite 9

10 Setzen der Methode auf POST Eingabe der URL für den gewünschten Server URL zur Testumgebung: Nun kann die XML-Datei für den gewünschten Request in den Request Body kopiert werden: portal.allyouneed.com Seite 10

11 Sind die Informationen vollständig kann der Request über den Send -Button abgeschickt werden. Der Status der Datenübermittlung erscheint unter dem Tab Response Header. Wurden die Daten korrekt und erfolgreich übermittelt ist der Status Code = 200 Auf jeden korrekten Request gibt es eine inhaltliche Rückmeldung, entweder die angeforderte Datenmenge oder eine Bestätigung der geladenen Daten. Diese Rückmeldung ist in dem Tab Response Body enthalten. portal.allyouneed.com Seite 11

12 4 Kontakt Sie haben Fragen, die in diesem Dokument nicht beantwortet wurden oder Anregungen und Hinweise für uns? Weitere Informationen und Hilfestellungen finden Sie in unserem Händlerportal unter: Weiterhin steht Ihnen unser Händler-Service Montag bis Freitag von 8 bis 18 Uhr zur Verfügung. Sie erreichen den Händler-Service via: haendlerservice@allyouneed.com Telefon: Kontaktformular: portal.allyouneed.com Seite 12

13 Änderungshistorie Version Datum Änderung Erstellung aus crest und REST-Client Doku portal.allyouneed.com Seite 13