Insights in unsere Shop-API

ABOUT YOU TECH
Jun 12, 2014 · 4 min read

Autor: Sebastian Betz

Seit unserem Launch ist viel passiert: Das Developer Center stößt auf große Resonanz, wir haben bereits über 100 Entwickler freigeschaltet, die sehr viele gute Ideen und Vorschläge für neue Apps mitbringen.

Die bisher am häufigsten gestellte Frage war die nach dem Funktionsumfang unserer Shop-API, deshalb möchten wir an dieser Stelle näher darauf eingehen.

Vorweg noch ein paar Worte zu unserer Motivation: Zum Start von Collins stand die Überlegung im Raum, wie wir eine Infrastruktur bauen können, auf die beliebig viele Shops und Plattformen aufsetzen können. Wir wollten etwas bauen, das Entwickler nicht einschränkt, sondern unterstützt.

Ziel unseres Produkts war und ist es, die Komplexität des E-Commerce so weit wie möglich zu reduzieren, ohne den Entwickler dabei zu entmächtigen. Es soll ihm die Freiheit geben, seine persönliche App-Idee schnell und unkompliziert umzusetzen.

Alle unsere Shops (z.B.aboutyou.de, edited.de, sistersurprise.de, mary-paul.de) aber auch alle Apps auf ABOUT YOU (aboutyou.de/apps) greifen auf die selbe API zurück — ohne Sonderlocken. Und genau das wollen wir auch in Zukunft so beibehalten. Deshalb gibt es hier im Developer Center die Möglichkeit, Feature-Requests einzubringen und die Development-Roadmap einzusehen.

Die Shop-API bietet eine Vielzahl von Funktionen an. Auf alle Funktionen einzugehen, würde den Rahmen sprengen, im Folgenden werden daher die am häufigsten genutzten Funktionen vorgestellt.

1. Authentifizierung & Autorisierung

Die Authentifizierung und Autorisierung erfolgt mittels einer Application-ID und einem API-Token.
Entwickler können bei uns schon bald auch direkt — ohne vorherige Freischaltung — Apps erstellen und das API-Token generieren.

2. Produktabfrage

Die wohl wichtigste Funktion unserer Shop-API ist die Abfrage von Produkten. Die Shop-API ermöglicht es, Produkte anhand ihrer ABOUT YOU-Produkt-ID (ABOUT NUMBER) abzufragen. Natürlich können pro Anfrage mehrere Product-IDs abgefragt werden.

Bei ABOUT YOU definieren wir einen Artikel als Produkt, z.B. ein bestimmtes T-Shirt in einer bestimmten Farbe. Ein Produkt hat nunmehr mehrere Varianten (z.B. für jede Größe — S, M, L).
Pro abgefragter Produkt-ID erhält man neben allen verfügbaren Varianten außerdem u.A. folgende Informationen:

Produkt Attribute
Produkt Attribute

Die Quantity ist allerdings nur als Richtwert zu verstehen und kann z.B. für die Ausgabe von einem „Nur noch wenig Produkte verfügbar” Infotext genutzt werden. Falls für die App ein eigener Kategoriebaum gepflegt wurde, wird die Kategorie des Produkts entsprechend zurückgeliefert.

Die Methode der Produktabfrage kann unter anderem für folgende Use-Cases genutzt werden:
- Artikel-Detailseite
- Produkte auf einem Outfit verlinken
- Daily-Deal / Liveshopping-Funktion
- Produkte für einen Newsletter abfragen

3. Produktbilder

Bei der Auslieferung der Produktbilder war uns wichtig, dass Applikationen keine Einschränkung in der Produktdarstellung und der Produktbild-Größe haben. Daher können Entwickler noch weitere Parameter für die Anzeige der Produktbilder festlegen:

- Breite und Höhe eines Produktbildes
- Bildausschnitt

Die Bilder müssen nicht auf dem Server der App gespeichert werden, sondern können direkt über unser Content-Delivery-Network abgerufen werden (auch bei individuell gesetzten Parametern, wie z.B. Höhe und Breite). Einen besonderen Use-Case stellt z.B. die App „Outfit Creator” dar — für die Kollagen werden hier Bilder mit einem transparenten Hintergrund benötigt.

4. Produktsuche

Natürlich muss nicht jede Produkt-ID einer App manuell herausgesucht werden. Um Produktlisten einfacher abzufragen gibt es eine spezielle API-Methode.

Neben der klassischen Produktsuche mittels Suchwort gibt es u.a. folgende Funktionen:

Zeige nur Produkte…
- einer bestimmten Kategorie (mehr dazu unter “7. Kategorien”)
- aus dem Sale / Nicht-Sale
- die preislich zwischen X und Y Euro liegen
- einer bestimmten Marke
- einer bestimmten Größe
- einer bestimmten 3. Größendimension (Cupsize, Jeans-Länge etc.)

Um die Ergebnisse schneller und besser bearbeiten zu können, bietet diese Methode diverse Möglichkeiten, um die Ergebnisse zu manipulieren. Zum Beispiel lassen sich alle Produkte sortieren, aber auch Limit und Offset können definiert werden (für Pagination oder Endless-Scrolling).

Zudem kann festgelegt werden, wie viel Information pro Produkt als Antwort zurückgegeben werden soll. Im Hinblick auf die Performance macht es natürlich Sinn, nur jene Produktinformationen abzufragen, die auch auf der Seite angezeigt werden sollen.

Außerdem kann man weitere Informationen, z.B. verfügbare Filter (inkl. deren Produktanzahl) zurückbekommen, um einen Preis-, Marken-, Kategorie- oder Farbfilter anzuzeigen.

Sinnvolle Use-Cases für die Produktsuche sind z.B.:
Die Anzeige…
- einer Kategorie- & Suchseite (inkl. aller Filtermöglichkeiten)
- einer Markenseite
- eines persönlichen Streams für Benutzer
- von passenden Produkten zu einem Thema
- von Top-Seller-Produkten

5. Ein Produkt in den Warenkorb legen

Es besteht auch die Möglichkeit, Produkte über die API in den Warenkorb eines Users zu legen. Dabei kann der Entwickler frei entscheiden, ob er mit absoluten oder relativen Werten arbeiten möchte, z.B.:

- Erhöhe die Anzahl von Produkt X im Warenkorb um 1
- Verringere die Anzahl von Produkt Y im Warenkorb um 2
- Setze die Anzahl von Produkt Z im Warenkorb auf 3

6. Den aktuellen Warenkorb abfragen

Die API stellt außerdem eine Methode zur Verfügung, um den aktuellen Warenkorb eines anonymisierten Users abzufragen. Wichtig ist hierbei, dass man nur den Warenkorb für seine eigene App abfragen kann — nicht den übergreifenden ABOUT YOU-Warenkorb aller auf der Plattform gekauften Produkte.

7. Kategorien

Was wäre ein Online-Shop ohne Kategorien! Natürlich hat jeder App-Entwickler die Möglichkeit, einen eigenen Kategoriebaum anzulegen. Diesen kann er über das Developer Center selbst verwalten und über eine Live-Vorschau anzeigen lassen.

Die Befüllung der Kategorien erfolgt mittels diverser Filter. So kann man z.B. auf Kategorien aus einem allgemeingültigen Basis-Kategoriebaum verweisen sowie Farb-, Marken-, Preis- und Suchwortfilter setzen oder auch einfach manuell Produkt-ID’s selektieren.

Der Kategoriebaum lässt sich anschließend über eine Shop-API-Methode abfragen. Bestimmte Abschnitte des Kategoriebaums können auch direkt über einen Parameter aufgerufen werden.

8. Abfrage von Marken und Attributlisten

Eine weitere Methode der Shop-API bietet Entwicklern die Möglichkeit, Attributlisten — z.B. vorhandene Größenläufe, Farben und Marken — für eine App abzufragen. Falls die App einen eigenen Kategoriebaum besitzt, werden nur jene Einträge zurückgeliefert, für die auch Produkte in den Kategorien existieren. Die selbe Methode kann genutzt werden, um Markenseiten anzeigen zu lassen.

ABOUT YOU TECH blog

Want to know more ABOUT TECH?

ABOUT YOU TECH

Written by

AY Dev news — fast & flexible. Check our vacancies https://corporate.aboutyou.de/en/jobs or our large-scale eCommerce infrastructure https://cloud.aboutyou.com

ABOUT YOU TECH blog

Do you want to know more ABOUT TECH? What we're developing? Which technologies we're using? Have a look at corporate.aboutyou.de/de/jobs. We successfully launched the 1st eCommerce infrastructure for large scale & innovative retail - ABOUT YOU CLOUD see https://cloud.aboutyou.com

ABOUT YOU TECH

Written by

AY Dev news — fast & flexible. Check our vacancies https://corporate.aboutyou.de/en/jobs or our large-scale eCommerce infrastructure https://cloud.aboutyou.com

ABOUT YOU TECH blog

Do you want to know more ABOUT TECH? What we're developing? Which technologies we're using? Have a look at corporate.aboutyou.de/de/jobs. We successfully launched the 1st eCommerce infrastructure for large scale & innovative retail - ABOUT YOU CLOUD see https://cloud.aboutyou.com

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store