Wie verwalte ich Extensions?
Extensions können derzeit nur über die REST API des mStudios verwaltet werden, nachdem du dich als Contributor registriert hast. mittwald arbeitet jedoch derzeit an einer umfassenden Verwaltung von Extensions im mStudio. Beachte bitte, dass der Marktplatz ein noch sehr junges Feature ist und wir derzeit, im Gegensatz zur restlichen REST API, keine Stabilitätsgarantie für die API Routen rund um den Marktplatz und die Extension Verwaltung aussprechen können. Die Routen, sowie Request- und Response-Formate können sich derzeit noch ändern.
Im Folgenden werden die wichtigsten Routen beschrieben, die benötigt werden, um über die API eine Extension zu verwalten.
Extension registrieren
Eine Extension kann über folgende REST API-Operation registriert werden:
POST/v2/contributors/{contributorId}/extensions/
Verpflichtend ist dabei lediglich ein Name. Wenn während der Entwicklung eine Extension Instance benötigt wird, muss zusätzlich noch ein Extension Context gesetzt werden. Dieser kann im Nachhinein noch geändert werden, solange die Extension nicht verifiziert ist.
Extension bearbeiten
Über die folgende Operation kann nach der Registrierung die Extension bearbeitet werden.
PATCH/v2/contributors/{contributorId}/extensions/{extensionId}/
Dabei gibt es jedoch ein paar Ausnahmen.
Über die REST-Operation POST/ wird der Upload von Assets, also Bildern für die Galerie im Marktplatz, angefragt.
Als Response erhältst du eine Asset Reference ID, die du verwenden kannst, um das Asset über die Operation POST/ hochzuladen.
Assets können über die Operation DELETE/ gelöscht werden.
Analog funktioniert das Hochladen eines Logos. Die Operation POST/ wird verwendet, um den Upload des Logos anzufragen.
Das Logo wird dann über die Operation POST/ hochgeladen.
Mit der Operation PUT/ kann der Extension Context einer Extension geändert werden.
Diese Route kann nur vor der Verifizierung der Extension verwendet werden.
Abhängig davon, ob bereits Extension Instances existieren, wird die Änderung entweder sofort wirksam oder es werden erst alle Extension Instances entfernt und danach die Änderung durchgeführt.
Für die Entwicklung von Frontend Fragmenten wird ein globales Extension Secret benötigt.
Um dieses zu generieren, wird die Operation POST/ verwendet.
Das Secret wird als Response zurückgegeben und kann dann in der Extension, bspw. über Umgebungsvariablen, verwendet werden.
Wenn die Operation erneut aufgerufen wird, wird ein neues Secret generiert.
Das alte Secret wird damit deprecated und wird in etwa 24h ungültig.
Diese Zeitspanne sollte genutzt werden, um das Secret in der Extension auszutauschen.
Extension verifizieren
Sobald deine Extension fertig entwickelt und einsatzbereit ist, kannst du über unsere REST API eine Überprüfung beantragen.
Dies geschieht über die Operation POST/.
Wir werden den Inhalt deiner Extension prüfen und sie verifizieren.
Nach erfolgreicher Verifizierung kannst du sie veröffentlichen.
Extension veröffentlichen
Nachdem deine Extension verifiziert wurde, kann sie veröffentlicht werden. Das ist ein separater Schritt, damit du die Kontrolle darüber behältst, ab wann die Extension für alle mStudio-Nutzer verfügbar ist.
Rufe zum veröffentlichen die Operation PUT/ auf.