Manifest & Registrierung

Der Vertrag zwischen App und Shop

Das Manifest ist der Vertrag zwischen App und Shop. Es beschreibt, wer die App ist, was sie darf und wie sie erreichbar ist – alles Weitere baut darauf auf.

Ort und Aufbau

Die manifest.xml liegt unter custom/apps/<AppName>/manifest.xml. Wichtig: Der Ordnername muss dem <name> im <meta>-Block entsprechen.

<?xml version="1.0" encoding="UTF-8"?>
<manifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <meta>
        <name>MyExampleApp</name>
        <label>Meine Beispiel-App</label>
        <version>1.0.0</version>
        <author>René van Dinter</author>
    </meta>
</manifest>

Was das Manifest deklariert

  • <meta> – Name, Label, Version, Autor
  • <setup> – Registrierungs-Endpunkt und Geheimnis (nur bei App mit Server)
  • <permissions> – welche Daten die App lesen/schreiben darf
  • <webhooks> – auf welche Events die App reagiert
  • <admin> – Module und Erweiterungen der Administration

Registrierung (Handshake)

Hat eine App einen eigenen Server, läuft beim Installieren ein Handshake: Shopware ruft den im <setup> hinterlegten Endpunkt auf, beide tauschen Signatur und Zugangsdaten aus und bauen so eine vertrauenswürdige Verbindung auf. Ab dann kann die App die Admin-API mit ihren Zugangsdaten nutzen.

Apps ohne Server brauchen keinen Handshake – dazu mehr im nächsten Kapitel.

Rechte werden bestätigt

Alle in <permissions> angeforderten Rechte werden dem Betreiber beim Installieren angezeigt und von ihm bestätigt. Deshalb gilt: nur anfordern, was die App wirklich braucht – das schafft Vertrauen und ist Pflicht für eine Store-Veröffentlichung.

Installieren

bin/console app:refresh          # neue App erkennen
bin/console app:install --activate MyExampleApp

Kurz: Manifest anlegen, Rechte sparsam deklarieren, bei Server-Apps den Handshake einrichten – das ist das Fundament jeder App.