Das Dokument beschreibt die Verwendung und Erweiterbarkeit der REST-API, einschließlich der Grundlagen, ersten Schritte, API-Beispiele sowie der lokalen API-Nutzung. Dabei werden die Prinzipien der REST-API, Sicherheitsmaßnahmen und verschiedene Ressourcen wie Artikel und Bestellungen erläutert. Zudem bietet es einen Ausblick auf zukünftige Entwicklungen in Shopware 4.2.

1. VERWENDUNG UND ERWEITERBARKEIT DER REST-API

2. AGENDA
•PRINZIPIEN DER REST-API
•ERSTE SCHRITTE
•API-BEISPIELE
•VERWENDUNG DER LOKALEN API
•BEISPIELE LOKALE API
•REST-API ERWEITERN / TAX
•AUSBLICK AUF SHOPWARE 4.2

3. PRINZIPIEN DER REST-API

4. PRINZIPIEN DER REST-API
GRUNDEIGENSCHAFTEN
Adressierbarkeit
Aufteilung nach Ressourcen
Standardisierter Zugriff über eindeutige Adressen
/articles/3, /orders …
HTTP-Operationen / Request-Methoden
GET, POST, PUT und DELETE
Sicherheit
Autorisierung über HTTP-Auth
Standardisierung
Einheitlicher Zugriff auf Ressourcen
JSON aus Austauschformat

5. PRINZIPIEN DER REST-API
WEITERE EIGENSCHAFTEN
Erweiterbarkeit
Implementierung eigener Ressourcen
Automatische Erweiterung durch Model-Attribute
Lokale Verwendung der API
Direkter Zugriff auf die API Ressourcen

6. PRINZIPIEN DER REST-API
ÜBERSICHT DER
RESSOURCEN
Ressource Adressierung Kurzbeschreibung
Article /articles Artikel
Customer /customers Kunden
Category /categories Kategorien
Order /orders Bestellungen
CustomerGroup /customerGroups Kundengruppen
Media /media Medienverwaltung
PropertyGroup /propertyGroups Eigenschaften
Shop /shops Shops / Subshops
Translation /translations Übersetzungen

7. ERSTE SCHRITTE

8. ERSTE SCHRITTE
API-KEY
API-Zugang aktivieren
Benutzername und API-Schlüssel dienen als
Autorisierungsgrundlage

9. ERSTE SCHRITTE
ERSTER TEST
HTTP-Call | localhost/api/articles
Benutzername und API-Schlüssel dienen als
Autorisierungsgrundlage
Default Request-Methode GET

10. ERSTE SCHRITTE
cURL SCRIPT
Welche Parameter werden benötigt?
Grundkonfiguration des cURL Request
Request-Methode definieren
Ausgabe: HTTP-Code / Response

11. ERSTE SCHRITTE
RESPONSE
Rückgabe der wichtigsten Daten

12. API-BEISPIELE

13. API-BEISPIELE
SPEZIFISCHER
ARTIKEL
Id des Artikels wird an die Adresse angehängt
Rückgabe aller relevanten Daten

14. API-BEISPIELE
ARTIKEL-UPDATE
Anpassung der Request-Methode
Array an Daten die aktualisiert werden sollen

15. API-BEISPIELE
NEUEN ARTIKEL ERSTELLEN
Welche Daten werden benötigt?
Trial and error

16. API-BEISPIELE
NEUEN ARTIKEL ERSTELLEN
(Zweiter Versuch)
Pflichtfelder hinterlegen
Id des neuen Artikel im Response

17. API-BEISPIELE
ARTIKEL LÖSCHEN
Umstellung auf die Request-Methode DELETE
HTTP-Code 200 = erfolgreich; Ansonsten 404

18. VERWENDUNG DER LOKALEN API

19. VERWENDUNG DER LOKALEN API
VORBEREITUNG: PLUGIN ERSTELLEN
Erstellt den neuen Controller TestApi
Dateistruktur:
Bootstrap.php: Frontend-Controller: TestApi.php:

20. VERWENDUNG DER LOKALEN API
INSTANZIIERUNG EINER API-RESSOURCE
Objekt der Ressource erstellen
Doctrine Models als Manager hinterlegen

21. VERWENDUNG DER LOKALEN API
VERFÜGBARE METHODEN DER RESSOURCEN
Methode Funktion
getOne Gibt einen Datensatz zurück (alle relevanten Daten)
getList Gibt einen Rowset an Daten zurück (nur die wichtigsten Daten)
create Erstellt einen neuen Datensatz
update Aktualisiert einen Datensatz
delete Löscht einen Datensatz
getOneByNumber Gibt einen Datensatz zurück (alle relevanten Daten)
updateByNumber Aktualisiert einen Datensatz
deleteByNumber Löscht einen Datensatz

22. BEISPIELE LOKALE API

23. BEISPIELE LOKALE API
ROWSET AN ARTIKELN (getList)

24. BEISPIELE LOKALE API
ZUSATZPARAMTER (getList)

25. BEISPIELE LOKALE API
SPEZIFISCHER ARTIKEL (getOne)
Alternative: getOneByNumber

26. BEISPIELE LOKALE API
ARTIKEL AKTUALISIEREN (update)
Alternative: updateByNumber

27. BEISPIELE LOKALE API
NEUEN ARTIKEL ERSTELLEN
(create)

28. BEISPIELE LOKALE API
ARTIKEL LÖSCHEN (delete)
Alternative: deleteByNumber

29. REST-API ERWEITERN / TAX

30. REST-API ERWEITERN / TAX
VORBEREITUNG – RESSOURCE TAX
Was wird benötigt?
Doctrine-Model
Tax API-Ressource
API Controller
Doctrine-Model ist bereits vorhanden
REST-API-CONTROLLERREST-API-CONTROLLER
API-RESSOURCEAPI-RESSOURCE
DOCTRINE MODELDOCTRINE MODEL

31. REST-API ERWEITERN / TAX
PLUGIN ERWEITERN
Lokales Verzeichnis im Namespace aufnehmen
Controller für die Rest-API hinzufügen

32. REST-API ERWEITERN / TAX
TAX API-RESSOURCE

33. REST-API ERWEITERN / TAX
TAX REST-API CONTROLLER

34. REST-API ERWEITERN / TAX
TEST REST-API

35. REST-API ERWEITERN / TAX
TEST LOKALE API

36. AUSBLICK AUF SHOPWARE 4.2

37. AUSBLICK AUF SHOPWARE 4.2
Allgemein
Performance
Events / Hookable
Cache-Ressource
Artikel-Ressource
Unterstützung von Staffelpreisen
Bilder-Handling
Optimierung der Artikel-Bild-Zuordnung
Variantenunterstützung
Unterstützung von Kategorien in der
Medienverwaltung
Plugins
Unterstützung von Premium Plugins
Bundle
Liveshopping
etc.

38. VIELEN DANK