Externe Schnittstellen
| Inhaltsverzeichnis |
APIs sind Programmierschnittstellen, mit deren Hilfe eine Anbindung an andere Systeme, Anwendungen usw. ermöglicht wird.
Welche Klassen und Methoden es gibt, wird in einer API-Dokumentation festgehalten.
MicroApp-JavaScript-API (High Level API)
FirstSpirit Content Experience Tools stellt eine JavaScript-API zur Verfügung, mit der die sogenannten „MicroApps“ (einzelne, isolierte Funktionen inklusive eigener Benutzeroberfläche) aufgerufen werden können.
Um die MicroApps aus der Vorschau im ContentCreator oder aus einer externen Anwendung heraus anzusprechen, werden in der Regel Buttons integriert, die beim Klick durch den Anwender eine Aktion ausführen, wie etwa das Bearbeiten eines Fragments oder das Starten eines Arbeitsablaufs.
REST-API (Low Level API)
Während die MicroApp-JavaScript-API Funktionen inklusive Benutzeroberfläche bereitstellt, bietet die CXT REST-API einen direkten Zugriff auf Ressourcen und Funktionen innerhalb der CXT-Plattform. Sie wird verwendet, etwa wenn Redaktionsdaten direkt gelesen oder manipuliert werden sollen.
Zur Dokumentation dieser API kommt dabei das OpenSource-Framework „Swagger“ zum Einsatz, das im Modul „FirstSpirit CXT FragmentCreator“ enthalten ist.
Die REST-Schnittstelle ist über eine URL erreichbar, die nach folgendem Schema gebildet wird:
http://<hostname>:<port>/<fragmentcreator-webapp>/swagger-ui.html
Dabei ist <fragmentcreator-webapp> der Wert, der für die globale Webanwendung für das Modul „FragmentCreator“ im Feld „Id“ vergeben wurde (siehe dazu auch Seite zur Konfiguration des Moduls FragmentCreator und Web-Applikationen (→Dokumentation für Administratoren)).
Beispiel:
http://localhost:8000/fragments/swagger-ui.html
Beispiel Swagger
 |
Die Schnittstellen sind aktuell noch nicht freigegeben. Eine Freigabe (zunächst für Partner) ist aber geplant. |
Interaktive API-Dokumentation
Zusätzlich zur Dokumentation der einzelnen REST-Endpunkte über Swagger steht eine interaktive API-Dokumentation bereit. Sie erläutert sowohl die CXT JavaScript-MicroApp-API als auch die REST-API leicht verständlich und anwendungsfallbezogen mit Hilfe von ausführbaren Beispielen.
Die Dokumentation liegt als FirstSpirit-Projekt vor und kann auf einem FirstSpirit-Server importiert werden.
Aktuell befindet sich das Projekt noch in einer Startphase und wird laufend erweitert. Bei Interesse wenden Sie sich bitte an Ihren Crownpeak-Betreuer.