Entwickler-Ressourcen

Auf dieser Seite findest du die wichtigsten Entwickler-Ressourcen rund um Journeys: von eigenen Blöcken über das Einbetten per SDK bis zur technischen Dokumentation auf docs.epilot.io.

Dieser Artikel richtet sich an Entwickler und technisch versierte Admins. Er zeigt dir, welcher Weg für welche Anforderung passt, und wo du die Details findest.

---

So funktioniert's

Je nachdem, was du vorhast, gibt es drei Wege:

• Eigene Funktion in der Journey: Du baust einen eigenen Block, zum Beispiel einen Tarifrechner oder eine Anbindung an dein System. Dafür nutzt du eine epilot App oder den Block Eigener API & SDK Block.

• Journey auf deiner Website steuern: Du bindest eine Journey mit dem Journey Embed SDK oder als Web Component ein und übergibst ihr Daten.

• Daten und Design anpassen: Du nutzt die Journey API, Kontextparameter, vorausgefüllte Journeys oder Custom CSS.

Eigene Blöcke entwickeln

Mit einer epilot App (empfohlen)

Eine App bündelt deinen Block mit Konfiguration, Berechtigungen und Versionen. Du entwickelst den Block als Web Component, installierst die App in deiner Organisation und richtest den Block danach wie jeden anderen App-Block ein, siehe App-Blöcke in Journeys.

• Start: Unter Konfiguration > Apps > Deine erstellten Apps legst du mit App erstellen eine neue App an. Zur Dokumentation führt dich direkt zur Entwickler-Doku.

• Einstellungen im Block: In der App legst du fest, welche Felder im Journey Builder unter Von der App verwendete Konfiguration erscheinen, zum Beispiel Text, Ja/Nein, Auswahllisten oder einen Referenzblock.

• Externe Systeme: Über die Komponente API-Proxy ruft dein Block externe Schnittstellen auf, ohne dass Zugangsdaten im Browser landen.

• Veröffentlichen: Du nutzt die App nur in deiner Organisation oder bietest sie nach einer Prüfung im Marktplatz an.

Dokumentation auf docs.epilot.io:

• Building Apps for epilot: Überblick über Apps und Komponenten

• Quick Start: erste App anlegen

• Custom journey block und Build a custom journey block: eigenen Journey-Block bauen

• API proxy: externe Schnittstellen sicher anbinden

• Private vs. Public Apps: App nur für deine Organisation oder im Marktplatz

Mit dem Block „Eigener API & SDK Block“

Für einfache Fälle bindest du eine eigene Web Component direkt im Journey Builder ein. Du gibst den Tag-Name und die Bündel-URL deines Skripts an und übergibst Werte über Args. Alles Weitere steht in Eigener API & SDK Block. Eine Vorlage findest du auf GitHub unter epilot-dev/custom-journey-block-react.

Journeys einbetten und steuern

Wie du eine Journey ohne Programmierung auf deiner Website einbindest, steht in Journeys auf deiner Website einbinden. Für mehr Kontrolle gibt es zwei technische Wege:

• Journey Embed SDK: JavaScript-Schnittstelle zum Einbetten. Du wählst Darstellung (inline oder Vollbild), übergibst Kontextdaten, füllst Felder vor, legst den Startschritt fest und reagierst auf Ereignisse wie das Laden oder Schließen der Journey. Siehe Journey Embed SDK.

• Web Component: Du bindest die Journey als HTML-Element <epilot-journey> direkt in deine Seite ein. Siehe Journeys als Web Components einbetten und Web Components.

Allgemeine Infos zum Einbetten stehen unter Embedding Journeys. Laden deine Seite strenge Sicherheitsregeln, hilft Content-Security-Policy (CSP).

Daten übergeben und Design anpassen

• Kontextparameter: Werte aus der URL oder dem Einbettungscode übernehmen, zum Beispiel eine Kampagnen-ID. Siehe Kontextparameter.

• Vorausgefüllte Journeys: Felder mit bekannten Daten befüllen. Siehe Vorausgefüllte Journeys.

• Tracking: Ereignisse an dein Analyse-Tool senden. Siehe Journey-Tracking auf deiner Website.

• Custom CSS: Darstellung über das Design hinaus anpassen. Siehe Custom CSS für Journeys und Custom CSS.

• Journey API: Journeys per Schnittstelle lesen und verwalten. Siehe Journey API.

Häufige Fragen

Brauche ich für eigene Blöcke einen Entwickler?

Ja. Eigene Blöcke sind Web Components, die in JavaScript programmiert werden. Fertige Blöcke von Partnern findest du ohne Programmierung im Marktplatz.

Was ist der Unterschied zwischen App-Block und „Eigener API & SDK Block“?

Ein App-Block kommt aus einer installierten App und bringt Konfiguration, Versionen und Berechtigungen mit. Beim Eigenen API & SDK Block hinterlegst du das Skript direkt im Journey Builder und kümmerst dich selbst um Hosting und Updates.

Wo finde ich die API-Referenz?

Alle Schnittstellen stehen auf docs.epilot.io, die Journey-Schnittstelle unter Journey API.