Skip to main content

Einbettung des Frontends

Das Frontend kann über ein HTML iframe-Element eingebettet werden. Dies erfolgt nach dem folgenden Schema:

<iframe 
	id="Frontend"
	class="frontend-iframe"
	allow="clipboard-read; clipboard-write"
	style="width:100%; height: 100%"
	src="http://<SQZ URL>/ui/index.html?apiKey=<APIKEY>&lang=<LANGUAGE>&page=/app/squeeze/<PAGE>&parameter=<PARAMETER>"
></iframe>
Squeeze URL Die URL zur Squeeze Installation
API-Key Kann aus dem Frontend abgerufen werden (unter 'Meine API Keys' in den Benutzereinstellungen)
Language

Wenn erforderlich, kann über den Parameter 'lang' eine Sprache angegeben werden.

 

Mögliche Werte: "de", "en", "pl", "it", "nl", "dk", "fr", "es", "us", "ch"

Die jeweilige Sprache muss im Frontend aktiviert sein, außer "de" und "en", da diese zum Standard gehören.
Page

Die Angabe der jeweiligen Seite erfolgt über den URL-Pfad wie im Frontend. Als Basis muss immer /app angeben werden.

 

Beispiel: /app/squeeze/embeddableReports
Parameter

(Optionale) seitenabhängige Parameter. 

 

Folgende Parameter stehen aktuell zur Auswahl für folgende URL-Pfade:

Page Parameter
/app/squeeze/embeddableReports
  • showReportAutovalidation
    • Anzeige des Autovalidation-Reports
  • showReportFieldSelectionQuality
    • Anzeige des Felderauslesequalität-Reports
    • Das Feature Flag reportValidatedDocuments muss aktiviert sein.
/app/squeeze/reports -

Demo Integration für das Squeeze Frontend (V2)

Dies kann auch getestet werden mittels der Datei im Squeeze Frontend Git-Projekt.
Der Pfad zu der Datei: /public/integration/index.html

No Comments
Back to top