API-Dokumentation

Die API-Dokumentationen (engl. für Application Programming Interface = Programmierschnittstelle) beschreiben die Schnittstellen zu FirstSpirit. Über diese Schnittstellen kann etwa in Vorlagen und Skripten auf die unterschiedlichsten Werte, Funktionen usw. zugegriffen werden.

Access-API

Die Access-API ist eine API für die Programmiersprache Java und gehört zu den wichtigsten Schnittstellen, die FirstSpirit bietet. Als Anbieter einer Enterprise-Software-Lösung verstehen wir bei Crownpeak die Bedeutung einer stabilen und zuverlässigen API für Entwickler. Um eine Balance aus dieser Stabilität und notwendigen Weiterentwicklungen zu erreichen, haben wir transparente Regeln für potenziell inkompatible Änderungen festgelegt:

• Methoden, Klassen und Funktionen, die inkompatibel verändert werden sollen, werden zunächst mit @Deprecated markiert. Die Dokumentation enthält dann weitere Informationen wie den Zeitpunkt der Abkündigung und eventuelle Alternativen.
• Die jeweiligen Release-Notes enthalten eine Übersicht der neu abgekündigten Code-Elemente.
• Methoden, Klassen und Funktionen, die auf diese Weise als deprecated markiert sind, werden frühestens nach sechs weiteren Releases aus der Access-API entfernt bzw. geändert.
• Module, die betroffene Code-Elemente verwenden, sollten innerhalb dieses Zeitraums angepasst und neu kompiliert werden. In diesem Fall ist eine Aktualisierung des betroffenen Moduls notwendig (siehe dazu Module (→Dokumentation für Administratoren) sowie Aktualisierung (→Dokumentation für Administratoren)).

Eine Einschränkung besteht für experimentelle API, die mit der Annotation @ApiStatus.Experimental versehen ist. Hier erfolgt keine Erwähnung in den Release-Notes und eine Entfernung bzw. Änderung kann bereits im nächsten Release nach der Markierung mit @Deprecated geschehen.

Die Dokumentation zur FirstSpirit Access-API kann über einen Klick auf den folgenden Verweis geöffnet werden:

• FirstSpirit Access-API-Dokumentation öffnen

Java SE Core-API

Die Java Standard Edition (SE) Core-API-Dokumentation von Oracle (allgemeine Funktionalitäten) kann über einen Klick auf den folgenden Verweis geöffnet werden:

• Java SE Core-API-Dokumentation öffnen

JavaScript-APIs

FirstSpirit stellt mehrere JavaScript-APIs zur Verfügung, die die funktionale Verknüpfung von Vorschaudokument und den Clients ContentCreator und SiteArchitect ermöglichen. So kann z. B. die Konfiguration von Parametern der Funktionalität „Multi Perspective Preview“ (Multi Perspective Preview (MPP) (→Handbuch FirstSpirit SiteArchitect)) vom HTML-Dokument in der integrierten Vorschau gesteuert werden, sodass Parameter nach Ereignissen im Dokument entsprechend angepasst werden.

ContentCreator

• ContentCreator-JavaScript-API (JS-Objekt top.WE_API)

SiteArchitect

• SiteArchitect-JavaScript-API (JS-Objekt top.JC_API)

Multi Perspective Preview (beide Clients)

• Multi Perspective Preview-JavaScript-API (JS-Objekt top.MPP_API)