Formulareinbettung

Vollständige API-Dokumentation zur Einbettung von Formularen in externe Websites.

Formulare werden per API in externe Websites eingebettet. Der API-Token und die Organisations-ID (orgId) bilden zusammen die Authentifizierung – beide müssen bei jedem Aufruf angegeben werden und werden gegeneinander geprüft. Ein gültiger Token mit falscher orgId wird abgelehnt.

Wichtig: Nur Vorlagen mit Status "active" können für Sessions, Formular-Laden und Formular-Absenden genutzt werden. Vorlagen im Status "draft" oder "archived" werden mit 404 abgelehnt.

Empfohlener Ablauf:

  1. API-Token im Dashboard unter „Konfiguration" erzeugen
  2. Vorlage erstellen (POST /api/embed/templates) und auf "active" setzen
  3. Session erstellen (POST /api/embed/sessions) mit token + orgId
  4. Zurückgegebenen iframe-Code auf der Website einbinden – der Token ist im Client nicht sichtbar, nur die Session-ID

Authentifizierung

Jeder API-Aufruf benötigt beide Werte:

ParameterBeschreibung
tokenAPI-Token (im Dashboard unter Konfiguration erzeugt)
orgIdUUID der Organisation (im Dashboard unter Organisation sichtbar)

Zwei Auth-Methoden je nach Endpunkt

1. Direkt (token + orgId als Parameter):

Für: Sessions, Templates, Submissions, Audit-Logs, Webhook-Events

2. Session-basiert (sessionId als Parameter):

Für: Template laden, Submit, Drafts, Upload, Webhook-Event

Die Session-ID enthält intern bereits token + orgId. Alternativ können diese Endpunkte auch mit token + orgId aufgerufen werden (z.B. für eigene Frontends ohne iframe).

Inhaltsverzeichnis

EinführungVorlagen verwalten