Überblick APIs (Programmier-Schnittstellen) und Parameter-Übernahmen


Es gibt verschiedene APIs (Application Programming Interfaces), sowie Parameter-Übernahmen.
In diesem Artikel erhalten Sie einen vollständigen Überblick.

1. GET-Parameter

Per GET-Parameter können verschiedene Werte Ihrem Formular, entweder fix oder variabel, übergeben werden. 
Meistens wird in der Praxis der Betrag, sowie das Projekt übergeben.

Sie können aber auch, z.B. den Haken für die Newsletter-Abfrage vorab belegen oder ein Land vorauswählen.

Beachten Sie hierzu auch die folgenden Artikel.
''Wie kann ich Werte in meinem Formular vorausfüllen?''
''Wie kann ich das Land innerhalb des Spendenformulars vorauswählen?''

In der DeveloperZone finden Sie alle verfügbaren GET-Parameter vollständig dokumentiert:
https://developer.fundraisingbox.com/docs/form-prepopulation-api

2. Benutzerdefinierte GET-Parameter

Zusätzlich stehen Ihnen benutzerdefinierte GET-Parameter bzw. Custom Fields zur Verfügung. Diese sind natürlich auch in unserer DeveloperZone angeführt. Diese dienen z.B. der Übermittlung von Tracking-Codes oder Werten, die bei einem eigenen und vorgeschalteten Formular abgefragt werden.

Beachten Sie hierzu auch folgenden Artikel.
''Wie kann ich dem Spendenformular eigene Informationen zu einer Spende hinzufügen?''

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

3. Parameter bei der Individuellen Erfolgsseite

Standardmäßig wird Ihrem Spender, nach einer erfolgreichen Spende, die Automatische Erfolgsseite im Browser angezeigt. Wenn Sie stattdessen eine Individuelle Erfolgseite anlegen bzw. nach erfolgter Spende auf diese verlinken möchten, stehen Ihnen auch hier verschiedene Parameter zur Verfügung, inklusive der Custom Variablen.

Beachten Sie hierzu auch folgenden Artikel.
''Wie kann ich Spender nach einer Spende auf eine eigene Erfolgsseite weiterleiten?''

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

4. Session API

Die Werte, die bei der Übermittlung per GET-Parameter in der URL angezeigt werden, können vom Spender verändert werden. U.a. deswegen, gibt es die Möglichkeit, die Werte via Session-API vorauszufüllen. Außerdem können beliebig viele Zeichen übergeben werden. Dies ist vor allem von Vorteil, wenn viele und/oder komplexe zusätzliche Daten in die Smart-Custom-Fields geschrieben werden und nicht mehr veränderbar sein sollen. Jedes Formular hat seine eigene ID/Token-Kombination.Wenn Sie den Token nicht in der Browser-Zeile angezeigt haben möchten,
kann Ihr Programmierer diesen ebenfalls in den Codeschnippsel einfügen.

Beachten Sie hierzu auch folgenden Artikel.
''Wie kann ich Werte in meinem Formular vorausfüllen?''

Hier einige Anwendungsbeispiele:


Weitere Informationen finden Sie in der DeveloperZone:
https://developer.fundraisingbox.com/docs/session-api-introduction

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

5. Web-Hooks

Durch sogenannte Web-Hooks haben Sie die Möglichkeit, Transaktionsdaten an eine, von Ihnen definierte Webservice-URL zu übermitteln (Push-Service).Jedem Spendenformular lässt sich dazu eine individuelle Benachrichtigungs-URL hinterlegen. Sobald eine Spende erfolgreich eingegangen ist, werden alle Transaktionsdaten an diese Adresse per XML in Echtzeit sicher übermittelt. Die Kommunikation mit dem aufgerufenen Webservice wird per AES-256-Bit SSL verschlüsselt. Dieser Aufruf erfolgt serverseitig, so dass er für den Spender nicht einsehbar oder manipulierbar ist. Der Zugriff kann per IP-Restriktion und HTTP-Authentifizierung (Nutzername/Passwort oder per API-Token) zusätzlich abgesichert werden. Der von Ihnen bereitgestellte Webservice übernimmt dann den Import der übermittelten Daten in Ihr externes System.

Hier einige Anwendungsbeispiele:


Weitere Informationen finden Sie in der DeveloperZone:
https://developer.fundraisingbox.com/docs/what-is-a-webhook

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

6. REST-API

Die REST-API erlaubt es Ihnen, alle wesentlichen FundraisingBox Objekte (Personen, Spenden, …), z.B. zu durchsuchen und zu lesen. Die Schnittstelle ist eine XML basierte REST-API, die sich programmiersprachenunabhängig einsetzen lässt. Diese Schnittstelle ist die umfangreichste Anbindung an die FundraisingBox und bietet die größmöglichste Flexibilität.Der Zugriff erfolgt durch HTTP-Authentifizierung. Jeder Nutzer besitzt einen eigenen API-Token. Dadurch lassen sich von jedem API-Nutzer die Rechte beliebig konfigurieren. Jeglicher Kommunikationsverkehr ist dabei per AES-256-Bit SSL abgesichert.

Hier einige Anwendungsbeispiele:


Weitere Informationen finden Sie in der DeveloperZone:
https://developer.fundraisingbox.com/docs/rest-api

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

7. Form-API

Die Form-API ist eine der mächtigsten und umfangreichsten Schnittstellen und richtet sich an alle, die in Zusammenarbeit mit der eigenen IT-Abteilung und / oder Agentur hochindividuelle Fundraising-Lösungen umsetzen möchten. Anstatt ein fertiges Formular in die eigene Webseite einzubinden, kann die Organisation ihren eigenen Rahmen,  z.B. dieses mehrschrittige Formular, entwickeln.

Dazu wird mit wenigen Zeile Programmiercode der sogenannte FormAPI-Client eingebunden und die FundraisingBox übernimmt dabei wie gewohnt alle komplexen Aufgaben wie z. B. Payment-Processing, Verschlüsselung, Bedankung, Datennormalisierung, Datenvalidierung, Dubletten-Abgleich und CRM-Synchronisierung.

Weitere Informationen und eine technische Beschreibung der Form-API finden Sie in unserer Developer-Zone.

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.

8. Payment-API

Durch die Payment-API lassen sich hochindividualisierte Fundraising-Tools realisieren, um auch komplett individuelle Anwendungsfälle wie z.B. eigene Charity-Chat-Bots und Hardware-Spendenlösungen umsetzen zu können.

Weitere Informationen und eine technische Beschreibung finden Sie in unserer Developer-Zone.

Wichtig:
Diese Funktion ist nicht in allen Varianten enthalten. Beachten Sie bitte unseren Variantenvergleich.



Online URL: https://support.fundraisingbox.com/article/Überblick-apis-programmier-schnittstellen-und-parameter-Übernahmen-23.html