Heute stellen wir ein schon lange vorhandenes Feature des Shopsystems vor, mit dem diverse individuelle Programmierungen möglich sind. Daher richtet sich dieser Artikel auch eher an Techniker oder die es noch werden wollen. Das Shopsystem besitzt eine integrierte REST API, aber was ist das eigentlich?
Der als REST bezeichnete einen Architekturansatz der beschreibt, wie verteilte Systeme miteinander kommunizieren können und sich dabei an den Paradigmen und Verhalten des World Wide Web (WWW) orientiert und einen Ansatz für die Kommunikation zwischen Client und Server in Netzwerken beschreibt.
Was das mit Ihrem Shop zu tun hat?
In den von unseren Programmierern umgesetzten Prozessen decken wir vor allem Standard-Prozesse des Onlinehandels ab. Interessant wird eine REST API für diejenigen, die Daten automatisiert aus dem Shop abrufen möchten um diese in eigenen Prozessen weiter zu verarbeiten. Der REST Standard ist ein plattformunabhängiger Standard, der den Einsatz verschiedener Programmiersprachen ermöglicht.
So kann ein Versanddienstleister die Auftragsdaten automatisiert abrufen oder sie nutzen die Kunden- und Auftragsdaten in angeschlossenen Systemen. Auch ein Abruf aktueller Produktdaten ist möglich zur Einbindung oder Darstellung in eigenen Webprojekten.
Sie haben eine Idee? Wir stehen gerne beratend zur Seite
Was kann man über die REST API abrufen?
Kategorien
- Alle Kategorien im Shop auslesen – als Liste
- Alle Kategorien im Shop auslesen – als Verzeichnisbaum
- Details einer bestimmten Kategorie auslesen
Produkte
- Alle Artikel einer Kategorie auslesen
- Details eines Artikels auslesen
- Liste der Varianten eines Produktes
Bestellungen
- Alle Bestellungen eines Jahres auslesen
- Alle Bestellungen eines Monats auslesen
- Details einer Bestellung auslesen
- Versandtracking setzen
- Bestellung abschließen
Kunden
- Alle Kunden auslesen
- Alle Kunden einer Kundengruppe auslesen
- Details eines Kunden auslesen
Die Schnittstelle wird schrittweise erweitert und bietet zukünftig auch Funktionen zur Aktualisierung oder Löschung von Daten.
Wie erfolgt die technische Anbindung?
Die API ist ohne vorherige Freischaltung oder Installation unter folgendem Endpunkt erreichbar: https://www.ihre-shopdomain.de/api/rest/v1
Selbstverständlich ist der Zugriff auf die API regelementiert. In der Shopadminstration unter Benutzer->API-Benutzer erstellen Sie dazu einen neuen Benutzer, bei dem der API-Key optional ist. Die Authentifizierung erfolgt pro Aufruf mit Benutzername und Kennwort. Der Abruf erfolgt über eine verschlüsselte Verbindung, sofern für den Onlineshop eine solche aktiv ist oder sie nutzen die interne Domain Ihres Shops, die immer eine Verschlüsselung bietet.
Weitere Informationen zu den einzelnen Ressourcen finden Sie in unserem WIKI unter http://wiki.serverspot.de/index.php?title=REST_API