Shopify API: Alles Wissenswerte zu den API-Schnittstellen

Shopify bietet Entwicklern und Partnern eine ganze Reihe an Shopify APIs an, mit denen sie die integrierten Funktionen der Shopify-Plattform erweitern oder neue Funktionalitäten hinzufügen können und die Interaktion mit anderen Systemen und Plattformen ermöglichen. Je nach Anwendungsfall kommen dabei unterschiedliche API-Schnittstellen zum Einsatz, wie beispielsweise die Shopify Admin API oder die Shopify Storefront API. Wofür steht API? Welche API-Anbindung ist spannend für Shopify? Im Beitrag möchten wir Ihnen einige APIs und ihre Verwendung vorstellen.

API - Was ist das?

Eine API, oder auch Application Programming Interface oder zu Deutsch Programmierschnittstelle, wird Entwicklern zur Verfügung gestellt, um externe Systeme anzubinden und die Interaktion zwischen beiden Systemen zu ermöglichen. Rein technisch betrachtet gibt eine Schnittstelle vor, wie Daten entgegengenommen und gesendet werden. Dies erfolgt auf Quelltext-Ebene, für die die Entwickler eine spezifische Syntax inklusive aller relevanten Parameter erstellen.

Häufig fällt in diesem Zusammenhang auch der Name REST API und GraphQL. Der größte Unterschied zwischen beiden ist die Art und Weise, wie Daten an den Client gesendet werden. Bei einer REST-Architektur stellt der Client eine HTTP-Anfrage und die Daten werden als HTTP-Antwort gesendet, während in GraphQL der Client Daten mit Abfragen anfordert. Bei Latori verwenden wir die zukunftsweisende ShopifyQL (bzw. die Shopify GraphQL Admin API) in fast jedem Kundenprojekt. Mehr dazu im Kapitel Shopify Admin API.

Shopify Admin API vs. Shopify Storefront API - Was sind die Unterschiede?

Der wesentlichste Unterschied der beiden APIs liegt im Zweck, den sie erfüllen sollen. Die Shopify Storefront API ist für Entwickler gedacht, die eine maßgeschneiderte Einkaufserfahrung für Kunden entwickeln möchten. Sie ermöglicht die Integration von Shopify-Daten in benutzerdefinierte Front-End-Anwendungen, mobile Apps oder andere Kundenschnittstellen.
Die Shopify Admin API hingegen richtet sich an Entwickler und Shop-Betreiber, die umfangreiche Anpassungen an ihrem Shopify-Shop vornehmen und automatisierte Prozesse implementieren möchten. Sie ermöglicht die Anbindung von Drittanbieter-Tools und die Automatisierung von Abläufen im Backend des Onlineshops.
Im nächsten Abschnitt gehen wir genauer auf die wichtigsten Shopify APIs und ihre Nutzung ein.

Beispiele der Shopify API: Shopify API Schnittstellen und ihre Verwendung

Im Folgenden stellen wir Ihnen die meistgenutzten Shopify APIs und ihre unterschiedlichen Einsatzgebiete etwas genauer vor.

Shopify Admin API

Mit der Shopify Admin API hat man die Möglichkeit, die Shopify-Nutzererfahrung nach seinen eigenen Wünschen zu gestalten. So lassen sich bestehende Shopify-Funktionen mit Apps erweitern, Inventar mit anderen Marktplätzen und Kanälen abgleichen, Daten zwischen Warenwirtschaftssystem und Shop austauschen oder Erweiterungen für Produkte, Bestellungen oder den Versand einstellen. Die Shopify-Schnittstelle unterstützt dabei GraphQL und auch REST. Diese Art der Schnittstelle nutzen wir bei unseren Shopify-Plus-Kunden bei nahezu jedem Projekt.

Shopify Storefront API

Die Shopify Storefront API bildet das Fundament für benutzerdefinierte Storefronts. Mit ihr hat man Zugang zu Shopify-Funktionen, wie z.B. die Anzeige von Produkten und Kollektionen, das Hinzufügen von Artikeln im Warenkorb oder kontextbezogene Preisberechnungen. So lassen sich einzigartige Einkaufserlebnisse für jede Frontend-Anwendung schaffen, wie z.B. für den Shop, eine Mobile App oder soziale Medien.

Shopify API Nutzung am Beispiel:

Die Storefront API haben wir beispielsweise für die Headless-Umsetzung unseres Kunden Horando eingesetzt und für die Entwicklung der Smartphone App von GoTiger.

Shopify Ajax API

Die Shopify Ajax API wird sehr häufig genutzt, um Anpassungen im Warenkorb vorzunehmen. Anwendungsfälle wären z.B., dass beim Hinzufügen von Produkten zum Warenkorb der Warenkorbzähler aktualisiert wird oder die Anzeige von relevanten Produktempfehlungen im Warenkorb.

Shopify Section Rendering API

Die Section Rendering API kann man wiederum nutzen, um Seiteninhalte zu aktualisieren, ohne die gesamte Seite neu zu laden, indem nur bestimmte Elemente abgerufen und aktualisiert werden. Angenommen, man hat mit der Ajax API den Warenkorb verändert, so kann man mit der Section Rendering API das Icon vom Warenkorb aktualisieren, damit es die richtige Anzahl an Produkten über den Zähler zeigt.

Shopify Customer Privacy API

Die Customer Privacy API ist sehr interessant, wenn es um das Thema DSGVO und die Abbildung vom Cookie Consent geht. Mit ihr haben Entwickler Zugriff auf Cookies und können entsprechende Banner zur Einwilligung erstellen.

Shopify Function API

Die Shopify Function API ist noch recht neu und wurde in der Shopify Editions Winter Edition vorgestellt. Sie erlaubt Entwicklern den Zugriff und die Anpassung von Backend-Funktionalitäten. Das könnte beispielsweise die Umsortierung von Zahlungsmethoden sein, die den Käufer angeboten werden, spezielle Rabatte im Warenkorb oder die Umbenennung von Lieferoptionen, die während des Checkouts zur Verfügung stehen.

Shopify Multipass

Mit Shopify Multipass lassen sich hervorragend Single Sign-on Lösungen umsetzen. Betreiben Händler neben dem Shop noch weitere Websites (z.B. ein Forum) oder eine Smartphone-App, müssen sich Nutzer nicht noch einmal anmelden und werden nahtlos mit derselben E-Mail-Adresse eingeloggt, sofern für die E-Mail ein Nutzerkonto existiert. Sollte noch kein Konto existieren, wird eines erstellt.

Shopify API Nutzung am Beispiel:

Auch bei unserem Kunden Asphaltgold müssen sich Benutzer des Webshops nicht erneut für die mobile Smartphone App registrieren, sondern nutzen den gleichen Login. Multipass kann zudem eingesetzt werden für die Migration von Passwörtern und Kundenkonten.

Schritt für Schritt: Shopify API einfach aktivieren (Anleitung)

Um beispielsweise Shopify-basierte Daten über eine externe Anwendung zu nutzen oder um spezielle Shopify-Apps zu entwickeln, muss man zunächst die Shopify API aktivieren. Dieser Schritt kann nicht rückgängig gemacht werden.

Nachfolgend erhalten Sie eine kurze Schritt-für-Schritt-Anleitung zur Aktivierung der Shopify API.

1. Wählen Sie im Shopify-Backend den Punkt Apps und anschließend App- und Vertriebskanaleinstellungen aus.

2. Klicken Sie auf das obere Feld Apps erstellen.

3. Bestätigen Sie Ihre Eingabe und klicken Sie auf den grünen Button Benutzerdefinierte App-Entwicklung erlauben.

4. Im Anschluss vergeben Sie einen App-Namen und füllen das Feld zum App-Entwickler aus.

5. Nun ist die Shopify API aktiviert und im nächsten Schritt können die Zugriffsbereiche konfiguriert werden, z.B. die Admin API oder die Storefront API und es kann ein API-Schlüssel vergeben werden. 

Eine detaillierte Konfiguration können wir an dieser Stelle leider nicht aufgreifen, da die Einstellung sehr individuell vom jeweiligen Anwendungsfall abhängt und mit äußerster Vorsicht vorgenommen werden sollte.

Häufige Fehler bei der Nutzung der Shopify API

• Falsche API-Version verwenden: Shopify bringt regelmäßig neue API-Versionen heraus und ältere Versionen werden nach einer bestimmten Zeit eingestellt. Wenn Sie eine veraltete API-Version verwenden, funktionieren bestimmte Endpunkte oder Funktionen nicht mehr.

• Rate-Limit: Shopify setzt API-Rate-Limits, um die Serverlast zu steuern. Wenn Sie zu viele Anfragen in kurzer Zeit stellen, werden Sie vom System gedrosselt und bekommen Fehler. Falsche Authentifizierung: Eine der häufigsten Fehlerquellen ist eine inkorrekte oder fehlende Authentifizierung bei API-Anfragen. Entweder wird der API-Schlüssel falsch verwendet oder die Authentifizierungsmethode ist veraltet.

• Fehler bei Webhook-Implementierunge: Webhooks werden verwendet, um Echtzeitdaten wie Bestellungen oder Lageraktualisierungen zu verfolgen. Ein häufiger Fehler ist jedoch, dass Webhooks nicht richtig verarbeitet oder validiert werden, was zu verpassten oder fehlerhaften Benachrichtigungen führt.

• Fehlende Fehlerbehandlung: Viele API-Integrationen implementieren keine robuste Fehlerbehandlung. Das führt dazu, dass API-Aufrufe fehlschlagen und keine entsprechenden Maßnahmen ergriffen werden.

• Falscher Umgang mit der Pagination: Bei der Abfrage von großen Datenmengen (z.B. Bestellungen oder Produkte) wird oft vergessen, dass die Shopify API die Ergebnisse paginiert. Ohne korrekte Handhabung der Pagination erhält man nur die ersten Einträge und verpasst den Rest.

• Fehlerhafte Datenvalidierung: Bei API-Requests wie Produktupdates oder Bestelländerungen werden Daten oft falsch formatiert oder Pflichtfelder fehlen, was zu 400er-Fehlern (Bad Request) führt.

• Unzureichende Sicherheitsmaßnahmen: Fehlender Schutz der API-Schlüssel, keine sichere Übertragung von Daten oder fehlende Einschränkungen der API-Berechtigungen können zu Sicherheitslücken führen.

• Fehlende Dokumentation des Codes: API-Integrationen werden häufig schlecht dokumentiert, was zu Verwirrung bei der Wartung oder bei neuen Teammitgliedern führen kann.

• Unzureichendes Monitoring und Logging: Ohne Monitoring und Logging sind Fehler in der API-Integration schwer zu erkennen und zu beheben.

Fazit

Egal ob man eine App entwickeln, Eingriffe im Shopify Storefront vornehmen oder Daten zwischen Systemen austauschen möchte, mit den unterschiedlichen Shopify APIs erhält man als Entwickler Zugriff auf die einzelnen Bereiche. So kann man ein unverwechselbares Einkaufserlebnis schaffen, die Conversion-Rate steigern und mehr Umsatz generieren.