Es ist so weit: Mit der modified-shop API veröffentlichen wir die erste offizielle REST-Schnittstelle für die modified eCommerce Shopsoftware. Ab sofort lassen sich Shopdaten und -funktionen programmatisch nutzen – für die Anbindung von Warenwirtschaftssystemen, Marktplätzen, ganz ohne Umwege über die Admin-Oberfläche.
Was die API kann
Die API stellt die zentralen Entitäten eures Shops als versionierte REST-Schnittstelle bereit – aufgebaut direkt auf dem bestehenden Shop-Kern. Über /api/v1/ stehen unter anderem Kunden, Produkte, Kategorien, Bestellungen, Hersteller, Attribute, Kupons, Versandarten, Länder, Währungen, Sprachen und Inhalte zur Verfügung – mit vollem CRUD-Umfang, wo es sinnvoll ist. Alle Anfragen und Antworten laufen durchgängig im JSON-Format.
Sicherheit von Anfang an
Der Zugriff erfolgt über eine JWT-basierte Authentifizierung mit kurzlebigen Access-Tokens (10 Minuten) und rotierenden Refresh-Tokens. Welches Kundenkonto auf welche Endpunkte zugreifen darf, verwaltet ihr direkt im Shop-Backend unter Kunden → API-Zugriff – granular pro Konto und pro Endpunkt. In Produktivumgebungen ist HTTPS Pflicht.
Webhooks statt Polling
Externe Systeme müssen den Shop nicht mehr regelmäßig abfragen: Über signierte Webhooks informiert die API angebundene Systeme aktiv über Shop-Ereignisse – zum Start über neue Bestellungen (order.created). Fehlgeschlagene Zustellungen werden automatisch mit steigendem Abstand erneut versucht, jede Zustellung ist per HMAC-Signatur verifizierbar.
Dokumentation inklusive
Die API dokumentiert sich selbst: Eine automatisch generierte OpenAPI-3-Spezifikation samt interaktiver Swagger UI ist unter /api/v1/docs/ in jeder Installation enthalten. Dort könnt ihr jeden Endpunkt durchstöbern und direkt im Browser ausprobieren – inklusive Login per Klick auf „Authorize".
Schnellstart
Code: Bash [Auswählen]# 1. Token holen
curl -X POST https://euer-shop.tld/api/v1/oauth \
-H "username:
[email protected]" \
-H "password: euer-passwort"
# 2. Endpunkt aufrufen
curl https://euer-shop.tld/api/v1/manufacturers \
-H "Authorization: Bearer <JWT>"
Voraussetzungen
modified eCommerce Shopsoftware 3.2.0 oder höherPHP 8.2 oder höherTechnisch basiert die API auf Slim 4 (PSR-7/PSR-15) mit Dependency Injection – modern, schlank und wartbar.
Mitmachen erwünscht
Die modified-shop API ist Open Source und lebt – wie die Shopsoftware selbst – von der Community. Der Quellcode ist auf GitHub verfügbar:
API-Repository: https://github.com/modified-shop/modified-shop-apiShopsoftware: https://github.com/modified-shop/modified-shopFehler gefunden oder Feature-Wunsch? Nutzt die GitHub Issues oder diskutiert mit uns im Forum.
Unser Anspruch bleibt derselbe wie beim Shop: keine kurzlebigen Trends, sondern eine stabile, gut dokumentierte und sichere Schnittstelle, auf die sich Händler und Entwickler langfristig verlassen können.
Viel Spaß beim Integrieren – euer modified eCommerce Shopsoftware Team
