Hinweis: Der folgende Artikel hilft Ihnen dabei: WooCommerce REST API: Alles, was Sie wissen müssen
Möchten Sie externe Anwendungen mit Ihrem WooCommerce-Shop verbinden oder Erweiterungen mithilfe asynchroner UI-Frameworks wie React erstellen? Mit der REST-API von WooCommerce können Sie Ihre Daten über HTTP-Anfragen erstellen, lesen, aktualisieren und löschen.
Die Möglichkeiten mit der WooCommerce REST API sind endlos. Sie können Ihren Online-Shop nahtlos in andere Anwendungen integrieren und Ihren Arbeitsablauf automatisieren. Stellen Sie sich vor, wie viel Zeit und Aufwand Sie durch die Optimierung Ihrer Prozesse sparen könnten.
In diesem Blogbeitrag erzähle ich Ihnen alles über die WooCommerce REST API und wie sie Ihnen dabei helfen kann, Ihr Online-Geschäft auf die nächste Stufe zu heben. Es eröffnet neue Möglichkeiten, von der Integration externer Anwendungen bis hin zum Aufbau leistungsstarker Erweiterungen. Lesen Sie weiter, um mehr zu erfahren!
Was ist eine REST-API und wie funktioniert sie?
Eine REST-API ist eine Möglichkeit für Softwareanwendungen, über das Internet miteinander zu kommunizieren. Es steht für RePräsentation State Transfer und befolgt eine Reihe von Richtlinien, um Integrationen einfach und skalierbar zu machen.
Wenn ein Client mithilfe einer REST-API Informationen von einem Server anfordert, sendet der Server den aktuellen Status der angeforderten Ressource in einem standardisierten Format zurück. REST-APIs verwenden HTTP-Anfragen, um Standarddatenbankfunktionen wie CRUD-Datensätze innerhalb einer Ressource auszuführen.
REST wird anderen Technologien wie SOAP vorgezogen, da es weniger Bandbreite benötigt und besser für die Internetnutzung geeignet ist.
Unterschied zwischen REST-API und SOAP-API
Hier ist eine Vergleichstabelle zwischen REST API und SOAP API:
REST-API | SOAP-API |
Architektonischer Stil | Protokoll |
Verwendet URIs, um Geschäftslogik offenzulegen | Verwendet eine Serviceschnittstelle, um Geschäftslogik verfügbar zu machen |
Flexibel und weniger definiert | Strukturiert und standardisiert |
Leicht, für die Internetnutzung geeignet | Robuster |
Kann Daten in verschiedenen Formaten übertragen | Kodiert Daten in XML |
Ideal für neuere Kontexte wie IoT, Entwicklung mobiler Apps und serverloses Computing | Funktioniert gut in verteilten Unternehmensumgebungen |
Vorteile der Verwendung der REST-API in WooCommerce
Die REST-API bietet bei der Verwendung in WooCommerce mehrere Vorteile. Zu den Vorteilen gehören:
- Die REST-API ermöglicht die Interoperabilität zwischen mehreren Plattformen.
- Es bietet Flexibilität bei der Anwendungsentwicklung.
- Es ermöglicht eine optimierte Konnektivität mit verschiedenen Geräten.
- Die REST-API ermöglicht eine mühelose Datensynchronisierung.
- Es erleichtert den Zugriff auf Inhalte Dritter.
Anforderungen für die WooCommerce REST API
WordPress-Permalinks sollten für Menschen lesbar sein. Der Permalink ist die URL Ihres Blogs, Ihrer Zielseite und Ihrer Produkte. Es gibt mehrere Optionen für Permalinks, z Schmucklos, Anschriftname, Numerischund mehr.
Einfacher Name ist die Option, die ich verwende. Sie können jede Option verwenden, aber alles andere als „Plain“ sollte funktionieren.
- Gehe zu Dashboard → Einstellungen → Permalinks.
- Wähle aus Anschriftname Wählen Sie die Option „Speichern“ aus und klicken Sie auf die Schaltfläche „Speichern“.
Erste Schritte mit der WooCommerce-API
WooCommerce ist eine Open-Source-E-Commerce-Plattform, die auf WordPress basiert. Mit der WooCommerce-API können Entwickler programmgesteuert mit den Daten des WooCommerce-Shops interagieren.
Führen Sie die folgenden Schritte aus, um mit der Verwendung der WooCommerce-API zu beginnen:
1. WooCommerce installieren und einrichten: Bevor Sie mit der Verwendung der WooCommerce-API beginnen können, muss WooCommerce auf Ihrer Website installiert und eingerichtet sein.
2. API-Schlüssel generieren: Um Anfragen an die API zu authentifizieren, müssen Sie API-Schlüssel generieren. Sie können dies tun, indem Sie zu den WooCommerce-Einstellungen navigieren und auf klicken Fortschrittlich Tab, gefolgt von REST-API. Von hier aus können Sie Schlüssel für jeden Benutzer generieren, der API-Zugriff benötigt.
3. Wählen Sie einen API-Endpunkt: WooCommerce bietet mehrere Endpunkte für den Zugriff auf verschiedene Datentypen, wie Bestellungen, Produkte, Kunden und mehr. Wählen Sie den Endpunkt aus, der den Daten entspricht, auf die Sie zugreifen möchten.
4. Stellen Sie eine API-Anfrage: Um eine Anfrage an die API zu stellen, können Sie jede Programmiersprache verwenden, die HTTP-Anfragen senden kann. Sie müssen Ihren API-Schlüssel in die Anforderungsheader einfügen, um die Anforderung zu authentifizieren.
5. Verarbeiten Sie die API-Antwort: Die API gibt Daten im JSON-Format zurück. Sie können diese Daten analysieren und bei Bedarf in Ihrer Anwendung verwenden.
Erstellen von API-Schlüsseln in WooCommerce
Das Erstellen von API-Schlüsseln in WooCommerce ist ein einfacher Vorgang, der nur wenige Schritte umfasst. Hier ist eine Schritt-für-Schritt-Anleitung zum Erstellen von API-Schlüsseln in WooCommerce:
- Melden Sie sich bei Ihrem WordPress-Dashboard an und navigieren Sie zu WooCommerce → Einstellungen.
- Klicken Sie auf die Registerkarte Erweitert und dann auf REST-API Tab.
- Drücke den Schlüssel hinzufügen/API-Schlüssel erstellen Klicken Sie auf die Schaltfläche, um einen neuen API-Schlüssel zu erstellen.
- Geben Sie eine Beschreibung für den API-Schlüssel ein Beschreibung Feld.
- Wählen Sie den Benutzer aus Benutzer Dropdown-Liste, die dem API-Schlüssel zugeordnet werden soll. Möglicherweise müssen Sie einen neuen Benutzer erstellen, wenn der gewünschte Benutzer nicht angezeigt wird.
- Wählen Sie die Berechtigungen aus, die Sie dem API-Schlüssel erteilen möchten Berechtigungen Dropdown-Liste. Sie können zwischen den Berechtigungen „Lesen/Schreiben“, „Nur Lesen“ und „Nur Schreiben“ wählen.
- Drücke den API-Schlüssel generieren Klicken Sie auf die Schaltfläche, um den API-Schlüssel zu generieren.
- Stellen Sie sicher, dass Sie die kopieren Verbraucherschlüssel Und Verbrauchergeheimnis Werte und speichern Sie sie an einem sicheren Ort, da Sie sie nicht mehr anzeigen können.
Und das ist es! Sie haben jetzt API-Schlüssel für Ihren WooCommerce-Shop erstellt, mit denen Sie programmgesteuert auf die Daten Ihres Shops zugreifen und mit ihnen interagieren können.
Testen, ob die REST-API in WooCommerce funktioniert
Bei der Arbeit mit RESTful-APIs ist es wichtig, deren ordnungsgemäße Funktionalität und Integration in Ihre Anwendung sicherzustellen. Indem Sie diese Schritte befolgen, können Sie die Funktionalität, Leistung und Zuverlässigkeit Ihrer REST-API-Endpunkte validieren und ein nahtloses Benutzererlebnis gewährleisten.
Aktivieren Sie die Legacy-Rest-API
Der erste Schritt besteht darin, das zu aktivieren Legacy-REST-API; Dazu müssen Sie die folgenden Schritte ausführen.
- Gehe zu WooCommerce → Einstellungen → Erweitert.
- Klick auf das Legacy-API Möglichkeit.
- Markieren Sie das Aktivieren Sie die alte REST-API Möglichkeit.
- Klick auf das Änderungen speichern Klicken Sie auf die Schaltfläche, um die Änderungen zu übernehmen.
Die Legacy-REST-API ist jetzt aktiviert. Der nächste Schritt besteht darin, es auf der API-Plattform zu testen. Ich werde die REST-API auf zwei API-Testplattformen testen; Briefträger Und Schlaflosigkeit.
Testen Sie die WooCommerce-REST-API auf Postman
Briefträger ist eine API-Plattform zum Erstellen und Verwenden von APIs. Zuerst müssen Sie sich anmelden, um die API auf Postman zu testen.
Die angeforderte URL, die wir testen werden, ist wp-json/wc/v3/orders. Für meine Website sieht die vollständige URL etwa so aus:
https://wordpress-1013933-3583354.cloudwaysapps.com//wp-json/wc/v3/orders
Ändern Sie dies, um Ihre eigene Website-URL zu verwenden.
Nachdem Sie sich erfolgreich bei Postman angemeldet haben, führen Sie die folgenden Schritte aus, um den REST-API-Test durchzuführen.
- Öffnen Sie zunächst die WooCommerce REST API-Dokument auf der neuen Registerkarte.
- Zweitens öffnen Sie den Postman auf der anderen Registerkarte Ihres Browsers.
- Gehen Sie zu Ihrem WooCommerce REST API-Dokument und suchen Sie nach den Bestellungen.
- Kopieren Sie den Code aus dem rechten Seitenbereich.
- Leiten Sie nun zum weiter Briefträger Tab.
- Klick auf das Sammlungen.
- Klick auf das Importieren.
- Paste den Bestellcode, den Sie kopiert haben WooCommerce REST API dokumentieren.
- Wähle aus Anfragetyp als ERHALTEN.
- Bearbeiten Sie die URL anfordern um die URL Ihrer eigenen Website zu verwenden.
- Nehmen Sie nun die Einstellungen auf der Registerkarte Autorisierung vor.
- Wählen Sie für Autorisierung die Option aus Grundlegende Auth.
- Geben Sie Ihr Verbraucherschlüssel Und Verbrauchergeheimnis Schlüssel von WooCommerce in die Nutzername Und Passwort Felder.
- Wenn Sie Ihren WooCommerce-Shop ordnungsgemäß eingerichtet und die REST-API aktiviert und API-Schlüssel generiert haben, sollte eine JSON-Antwort angezeigt werden, die eine Liste der Produkte in Ihrem Shop enthält. Die Antwort sollte etwa so aussehen:
- Hier ist das Leitfaden zur Postman-Plattform mit der Markierung, die Ihnen helfen kann zu verstehen, wo Sie Änderungen vornehmen müssen.
Testen Sie die WooCommerce REST API auf Insomnia
Die zweite Plattform, die wir zum Testen der REST-API verwenden, ist Schlaflosigkeit. Wenn Sie APIs entwerfen, debuggen und testen möchten, ist Insomnia ein Tool, mit dem Sie mit einer entwicklungsfreundlichen Oberfläche schneller und gemeinsam bessere APIs erstellen können.
Zuerst müssen Sie Insomnia auf Ihrem System installieren. Sobald es installiert ist, müssen Sie die folgenden Schritte ausführen, um REST-API-Tests durchzuführen.
- Wähle aus Anfragetyp als ERHALTEN.
- Bearbeiten Sie die URL anfordern um die URL Ihrer eigenen Website zu verwenden.
- Wählen Sie für Autorisierung die Option aus Grundlegende Auth.
- Geben Sie Ihr Verbraucherschlüssel Und Verbrauchergeheimnis Schlüssel von WooCommerce in die Nutzername Und Passwort Felder.
- Klick auf das Schicken Taste. Sehen Sie sich die Ergebnisse im an JSON-Format Bei der rechtes Panel.
- Hier ist das Leitfaden zur Insomnia-Plattform mit der Markierung, die Ihnen helfen kann zu verstehen, wo Sie Änderungen vornehmen müssen.
Wenn Sie eine solche Antwort erhalten, herzlichen Glückwunsch! Ihre REST-API funktioniert ordnungsgemäß. Wenn ein Fehler auftritt, überprüfen Sie unbedingt Ihre API-Anmeldeinformationen und stellen Sie sicher, dass Sie die REST-API in WooCommerce ordnungsgemäß aktiviert haben.
Behebung häufiger Probleme der REST-API
Obwohl die REST-API ein leistungsstarkes Tool zum Erstellen robuster und skalierbarer Anwendungen ist, birgt sie Herausforderungen.
1. SSL-Verifizierung
Wenn Sie Verbindungsfehler erhalten, z. B Konnte keine Antwort erhalten Auf Ihrem Localhost müssen Sie es deaktivieren SSL-Verifizierung. Sie können es deaktivieren Briefträger Plattformeinstellungen.
Gehe zu Anwendung → Einstellungen in Schlaflosigkeit und deaktivieren Sie das Kontrollkästchen Validieren Sie Zertifikate während der Authentifizierung.
2. 401 Unautorisierter Fehler
401-Statuscodes für nicht autorisierte Antworten sind serverbezogene Fehler. Stellen Sie sicher, dass die URL korrekt eingegeben wurde. Achten Sie darauf, die zu platzieren Verbraucherschlüssel Und Verbrauchergeheimnis richtig.
Der Grund können Ihre API-Schlüssel sein oder die Signatur muss korrigiert werden. Wenden Sie sich an den Dienstanbieter des Endpunkts, den Sie anrufen möchten.
3. Verbraucherschlüssel fehlt
Manchmal übergeben Server den Authorization-Header möglicherweise nicht ordnungsgemäß, was zu der Fehlermeldung „Consumer Key fehlt“ führt, insbesondere bei der Authentifizierung über SSL.
Wenn dieses Problem auftritt, besteht eine alternative Lösung darin, stattdessen den Verbraucherschlüssel und das Geheimnis als Abfragezeichenfolgenparameter bereitzustellen.
Sie können sie beispielsweise wie folgt in die URL einbinden:
https://example.com/wp-json/wc/v2/orders?consumer_key=XXXX&consumer_secret=XXXX.
Zusammenfassung
Zusammenfassend lässt sich sagen, dass die WooCommerce REST API ein großartiges Tool für alle ist, die ihr Online-Geschäft verbessern möchten. Damit können Sie Ihren Shop mit anderen Anwendungen verbinden und Ihren Arbeitsablauf automatisieren. Das bedeutet, dass Sie durch die Optimierung Ihrer Prozesse Zeit und Aufwand sparen können.
Bevor Sie beginnen, stellen Sie sicher, dass Sie die Anforderungen erfüllen und Ihre API-Schlüssel generieren. Dadurch erhalten Sie Zugriff auf die REST-API und alle ihre Funktionen. Ich hoffe, dieser Blogbeitrag hat Ihnen geholfen, die WooCommerce-REST-API zu verstehen und zu verstehen, wie sie Ihrem Online-Geschäft zugute kommen kann.
×