Überblick über Formular-APIs und Parameter-Übernahmen

INHALTSVERZEICHNIS

• Welche Möglichkeiten gibt es?
  • 1. Formularwerte mit GET-Parametern vorausfüllen
  • 2. Eigene Werte mit benutzerdefinierten GET-Parametern übergeben
  • 3. Parameter an eine individuelle Erfolgsseite übergeben
  • 4. Eigene Formulare mit der Form-API entwickeln
  • 5. Individuelle Fundraising-Lösungen mit der Payment-API umsetzen

Mit Formular-APIs und Parameterübernahmen kannst Du Werte an klassische FundraisingBox-Formulare übergeben, individuelle Abläufe umsetzen oder eigene Fundraising-Lösungen entwickeln. Dieser Artikel zeigt Dir, welche Möglichkeiten zur Verfügung stehen und wofür Du sie einsetzen kannst.

Welche Möglichkeiten gibt es?

Im Formular-Bereich stehen Dir verschiedene Schnittstellen und Möglichkeiten zur Parameterübernahme zur Verfügung. Je nach Anwendungsfall kannst Du damit beispielsweise:

• Formularfelder automatisch vorausfüllen,
• Betrag, Zahlungsrhythmus oder Projekt vorgeben,
• Tracking-Informationen übertragen,
• Werte an eine individuelle Erfolgsseite weitergeben,
• eigene Formularoberflächen entwickeln oder
• individuelle Fundraising- und Payment-Lösungen umsetzen.

Hinweis: Einige Funktionen stehen nur in bestimmten FundraisingBox-Varianten oder als optionale kostenpflichtige Erweiterung zur Verfügung. Bei Fragen hierzu wende Dich gerne an das FundraisingBox-Support-Team.

1. Formularwerte mit GET-Parametern vorausfüllen

Mit GET-Parametern übergibst Du Werte über die URL an Dein Formular. Die Werte können fest vorgegeben oder dynamisch erzeugt werden.

Typische Anwendungsfälle sind:

• Spendenbetrag vorauswählen,
• Zahlungsrhythmus festlegen,
• Projekt vorauswählen,
• weitere Formularfelder vorbelegen,
• Checkboxen vorauswählen oder
• ein Land vorgeben.

Bestimmte GET-Parameter kannst Du direkt über den Button-Generator erzeugen. Dadurch musst Du die entsprechenden Parameter nicht manuell erstellen.

Tipp: Anwendungsbeispiele findest Du im Hilfe-Artikel Werte im Formular vorausfüllen. Eine technische Übersicht aller verfügbaren GET-Parameter findest Du in der DeveloperZone.

2. Eigene Werte mit benutzerdefinierten GET-Parametern übergeben

Für individuelle Informationen kannst Du benutzerdefinierte GET-Parameter beziehungsweise Custom Fields verwenden. Diese ermöglichen Dir, zusätzliche Werte an die FundraisingBox zu übertragen.

Du kannst sie beispielsweise einsetzen, um:

• eigene Tracking-Informationen zu übergeben oder
• Werte aus einem vorgeschalteten eigenen Formular weiterzugeben.

Die verfügbaren benutzerdefinierten Parameter findest Du ebenfalls in der DeveloperZone.

3. Parameter an eine individuelle Erfolgsseite übergeben

Nach einer erfolgreichen Transaktion sehen Spender*innen standardmäßig die automatische Erfolgsseite im Browser.

Alternativ kannst Du eine eigene Erfolgsseite verwenden und Spender*innen nach der Transaktion dorthin weiterleiten. Dabei kannst Du verschiedene Parameter an Deine Erfolgsseite übertragen. Abhängig von Deiner FundraisingBox-Variante können dazu auch benutzerdefinierte Variablen gehören.

Wie Du eine eigene Erfolgsseite einrichtest und verwendest, erfährst Du im Artikel Individuelle Erfolgsseite nach einer Transaktion nutzen.

4. Eigene Formulare mit der Form-API entwickeln

Die Form-API eignet sich für hochindividuelle Fundraising-Lösungen, die Du gemeinsam mit Deiner IT-Abteilung oder einer Agentur entwickelst. Statt ein fertiges FundraisingBox-Formular in Deine Website einzubinden, kannst Du eine eigene Formularoberfläche erstellen.

Wichtig: Sprich vor umfangreichen individuellen Anpassungen per Code mit unserem Support-Team. Unsere Formularlösungen werden aktuell neu entwickelt. Wir können Dich beraten, welcher Ansatz für neue Projekte langfristig sinnvoll ist.

Ein Beispiel ist ein individuell entwickeltes mehrschrittiges Formular.

Für die Anbindung integrierst Du den sogenannten FormAPI-Client in Deine Anwendung. Die FundraisingBox übernimmt anschließend weiterhin zentrale technische Prozesse, beispielsweise:

• Payment-Processing,
• Verschlüsselung,
• automatische Dankes-E-Mails und
• Datennormalisierung.

Die technische Dokumentation findest Du in der DeveloperZone zur Form-API.

5. Individuelle Fundraising-Lösungen mit der Payment-API umsetzen

Mit der Payment-API kannst Du hochindividualisierte Fundraising-Tools entwickeln. Sie eignet sich insbesondere für Anwendungsfälle, die über klassische Online-Spendenformulare hinausgehen.

Wichtig: Sprich vor umfangreichen individuellen Anpassungen per Code mit unserem Support-Team. Unsere Formularlösungen werden aktuell neu entwickelt. Wir können Dich beraten, welcher Ansatz für neue Projekte langfristig sinnvoll ist.

Mögliche Anwendungsfälle sind beispielsweise:

• eigene Charity-Chatbots oder
• individuelle Hardware-Spendenlösungen.

Die technische Beschreibung findest Du in der DeveloperZone zur Payment-API.