REST API

Aus DreamRobot Wiki
Wechseln zu: Navigation, Suche

Um externe Software zu programmieren, damit von dort DreamRobot ferngesteuert werden kann, wird die Implementierung von Funktionen mittels REST API empfohlen. Die Implementierung (Programmierung auf Seiten der externen Software) kann nur durch Sie selbst oder externe Dienstleister erfolgen. Unsere Technik übernimmt keine Anpassungen in externer Software. An DreamRobot muss dazu nichts angepasst werden. DreamRobot nimmt Aufrufe der externen Software entgegen und liefert dazu Daten zurück oder startet Funktionen in DreamRobot.

Folgende Aufgaben kann die REST API erledigen:

  • Lager (inkl.: Varianten, Sets, PüMa, Beschreibungen, Lister(eBay, Hood, Yatego, Shop), Amazon, Webshop, Rakuten, Fnac, ePages, real,-) anlegen, abrufen und im Portal einstellen/aktualisieren (nur Protokollfunktionen).
  • Aufträge anlegen, abrufen, aktualisieren(z.B. Status oder Adresse ändern), Ware-Unterwegs-Mail senden.


Unter https://www.dreamrobot.de/download/REST_API-v1.1-Documentation.zip können Sie ein Archiv mit ein paar Dateien downloaden, die das Arbeiten mit der API exemplarisch in einer PHP Umgebung ermöglichen. Außerdem ist in dem Archiv eine umfangreiche PDF-Dokumentation der Schnittstelle enthalten; die aktuelle Version können Sie auch immer online unter https://www.dreamrobot.de/rest/Doku/doku.php einsehen.

Die Schnittstelle unterstützt in allen Bereichen individuell XML/JSON, sowie ISO-8859-15/UTF-8 als Input und Output, abhängig von den gesetzten Headern.

Falls Sie eine Aktivierung der API beantragen, teilen Sie uns bitte eine separate Email-Adresse für Rückfragen und Statusmeldungen mit. Dies sollte nicht die Email-Adresse sein, an die DreamRobot Ihre Rechnungen sendet. Wir benötigen diese zusätzliche Email-Adresse z.B. für technische Rückfragen/Statusmeldungen zur REST API.

Während der 2-wöchigen Testphase ist die Nutzung der REST API kostenlos. Wählen Sie bitte innerhalb der Testphase Ihren nachfolgenden Tarif aus. Andernfalls landen Sie im kostenfreien Default-Tarif mit nur 5 Anfragen pro Tag.

Partnerunternehmen, die Anbindungen der REST API im Auftrag von DreamRobot Anwendern vornehmen, und selbst keine Warenverkäufe über DreamRobot abwickeln, können die REST API im Rahmen eines kostenlosen DreamRobot Entwickleraccounts anbinden.

Wenn Sie jetzt einen API-Zugang erhalten möchten, wenden Sie sich bitte per Mail an support@dreamrobot.de

REST API Benutzerverwaltung

Unter "Admin -> MyAccount" können Sie Ihre REST API Zugänge verwalten, Tarife wechseln und, abhängig vom Anwendungsfall, unterschiedliche Berechtigungen zuweisen. Bei externer Software empfehlen wir, diese wie vorausgewählt zu belassen, sofern Sie keine Einschränkung der Funktion planen.

REST API History

Unter "Admin -> MyAccount -> API History" können Sie alle Anfragen die auf Ihren Account gesendet wurden einsehen.

Hierzu stehen verschiedene Filter zur Verfügung:
- Datums-Filter: von ... bis ... (kann nur max. 30 Tage in die Vergangenheit sehen.)
- Client-Filter: Wer hat die Anfrage gestellt?
- Error-Filter: Nur Fehler / Keine Fehler
- Modul-Filter: Es kann auf die einzelnen Bereiche der API gefiltert werden (z.B. Stock oder Order).
- Zusätzlich steht eine Suchfunktion zur Verfügung um z.B. nach Statuscode, Pfad oder HTTP-Methode zu Filtern.

Durch einen Klick auf die "Anfrage" oder "Antwort" kann die Detaillierte Anfrage/Antwort angezeigt werden.

REST-API-History.png