Headless Api

Mit der Headless Api ist es möglich CMS-Seiten auf über eine JSON-Schnittstelle direkt auf andere Webseiten auszuliefern.

Beschreibung

Die bietet die Möglichkeit Endpunkte zu registrieren auf denen der jeweilige Inhalt einer CMS-Seite veröffentlicht wird. Der Endpunkt repräsentiert die Seite auf der ein Javascript-Snippet platziert wird.
Im Tab „Code“ wird der Javascript-Code angezeigt, der in einem beliebigen fremden System (bswp. Typo3, Wordpress, o.ä.) platziert werden kann.

Konfiguration

Klicken Sie die Tabelle Headless Endpoint
Legen Sie einen neuen Endpoint an

Allgemein

Hinterlegen Sie die Domain auf die das Javascript zeigen soll. Üblich wäre die Hauptdomäne die in brandbox hinterlegt ist
Hinterlegen Sie das Url Muster (siehe unten)
Wählen Sie ein Api Package

Headless CMS Client

Der CMS Client ist in der Lage eine im brandbox cms erstellte Seite auszuliefern. Wählen Sie dieses Api Package und hinterlegen eine Konfiguration. In der Konfiguration ordnet man die Seite zu, die hier ausgeliefert werden soll.

Beispiel

{
  "shortLink": "home",
  "locale": "de_DE"
}

Url Muster

Url Muster werden zeilenweise gepflegt. Sie können folgende Formen haben.
Weitere Informationen: https://de.wikipedia.org/wiki/Uniform_Resource_Locator

Form	Beschreibung

Form

Beschreibung

Exaktes Muster

Exaktes Muster
Die Anfragende Url muss exakt identisch sein. Domain, Pfad und Query müssen identisch sein.

Domain + Pfad müssen identisch sein
Die Anfragende Url darf Parameter enthalten, um den Inhalt der anfragenden Website zu steuern. Diese Parameter werden ignoriert.

Beispiel

https://www.konmedia.com/pfad/datei.php?query=test (Konfiguration)
https://www.konmedia.com/pfad/datei.php?query=test (ok)
https://www.konmedia.com/pfad/andere-datei.php?query=test (nicht ok)

Wildcards

Es ist möglich Wildcards einzusetzen, um die Url zu dynamisieren.

Beispiel

https://www.konmedia.com/pfad/*.php?query=test (Konfiguration)
https://www.konmedia.com/pfad/datei.php?query=test (ok)
https://www.konmedia.com/pfad/andere-datei.php?query=test (ok)

Rechte

Es braucht eine öffentliche Rolle, mit der es möglich wird die Inhalte dieses Endpoints sowie die Inhalte der CMS-Seite auszuliefern.
Legen Sie dazu eine öffentliche Rolle an und wählen die entsprechenden Autorisierungen. Mindestens notwendig:

„Headless Api“
Für Tests zusätzlich „Headless Tester“

Konfiguration von X-Frame-Options

Der Server muss die Anfragende Domain erlauben. Dazu ist es notwendig die Assets sowie die Datein, die von brandbox ausgeliefert werden freizugeben.

Klicken Sie in der Navigationsleiste auf das Schraubenschlüssel Symbol und loggen Sie sich als Administrator ein.
Öffnen Sie den Bereich „Sicherheit“ und wählen „Security Header“.
Geben Sie folgende Werte ein:
- Frame-Einstellung: allow-from
- Domain für Frame-Option "allow-from": Die Domain des Kunden