minasa-cms:frontend-api [Minasa-Plattform]

Diese Seite ist nicht editierbar. Du kannst den Quelltext sehen, jedoch nicht verändern. Kontaktiere den Administrator, wenn du glaubst, dass hier ein Fehler vorliegt.

====== Minasa Frontend API ======

Das Minasa-System bietet ein read-only-REST-JSON-API für öffentliche CMS-Daten an. Dies kann z.B. verwendet werden, um ein headless CMS-System damit anzubieten.

Das Minasa HTML-Widget macht ebenfalls von dieser REST-API gebrauch: Alle Daten für das HTML-Widget werden aus der Frontend-API geliefert.

Die Frontend-Daten können somit anstatt als gerendertes HTML als JSON abgeholt werden. Der Einstiegspunkt zur API lautet:

''[webroot]/services/frontend-api/v1/[api-anfrage]''

Die API ist getrennt von der backend-API, welche für das Cockpit verwendet wird. Die Frontend-API liefert nur öffentliche Daten, welche auch via Webseite ausgespielt werden würde.

Die API offeriert eine OpenAPI-Dokumentation:

''[webroot]/backend/frontend-api/api-doc/index.html''

[[https://thurgaukultur.ch/backend/frontend-api/api-doc/index.html|Beispiel-OpenAPI-Dokumentation]]

===== Authentifikation =====

Ein API-Key muss im HTTP-Header ''X-API-Key'' mitgeliefert werden. Der API-Key muss mittels ''minasa-cli api-key create --scopes=frontend.api.public_read --contact-email=...'' erstellt werden.

Beispiel-Aufruf mit CURL:

''curl --location 'http://localhost:8080/webroot/services/frontend-api/v1/ping' \ --header 'X-API-Key: ..............' ''