Lösungsstartseite Externe Services & Schnittstellen API Package

Schnittstellen zu Drittsystemen herstellen (REST API & Webhooks)

Geändert am: Fr, 17 Okt, 2025 um 2:15 NACHMITTAGS

Applicable plans a b c d

INHALTSVERZEICHNIS

In diesem Artikel erfahren Sie, wie die Daten der FundraisingBox automatisiert in Drittsysteme übertragen können, wenn die FundraisingBox hierfür keine Standard-Schnittstelle (siehe z.B. Store > Integrations und Store > Externe Services) bereitstellt.

Hinweis: Technisch ist hierfür das "API Package" nötig, das nicht in allen FundraisingBox Vertrags-Varianten enthalten ist. Sollten Sie unsicher sein, ob die Funktion bei Ihnen nutzbar ist, kontaktieren Sie uns gerne.

Gut zu wissen

  • Die FundraisingBox kann über zwei Optionen an ein Drittsystem selbst angeschlossen werden:
    • a) über Webhooks (für einen Live-Sync)
    • b) über REST-API (für einen asynchronen Sync, z.B. einmal täglich)
  • Grundlegend ist der aktuellste technische Stand immer in unserer DevZone (separate Seite) beschrieben
  • Wir bieten hier nur einen groben Überblick zur Funktionsweise und Handhabung

Allgemeine Worte über die "API-Package" Funktionen

  • Das API-Package bietet Ihrer IT Abteilung einen standardisierten Zugriff auf eine Vielzahl der Daten innerhalb der FundraisingBox.
  • Mit etwas Programmierung können sie so einfach Daten (z.B. Spenden) in andere Software-Systeme (z.B. Banking-Software, externes CRM) synchronisieren.
  • Somit können alle Spenderdaten automatisch übermittelt werden, ohne dass Sie diese über manuellen Export/Import synchronisieren müssen. 
  • Gleichzeitig können Sie auch Informationen über die API zurück in die FundraisingBox übermitteln und diese dort nutzen (z.B. im Spendenmanagement).

Für folgende CRM-Anbieter steht eine direkte Schnittstelle über das API-Package zur Verfügung, sodass die Anbindungen schnell erfolgen: 

Tipp: Das API-Package kann natürlich für weitere Anwendungen oder CRM-Anbieter verwendet werden. Bitte halten Sie hierzu Rücksprache mit Ihrer Agentur oder Ihrem Dienst und melden Sie sich bei Unklarheiten gerne bei uns.

Wann Webhooks und wann die REST-API verwenden?

  • Webhooks:
    • Format: JSON
      • Wir bieten derzeit noch (das veraltete Format) XML parallel an, dieses ist jedoch nicht mehr empfohlen für neue Anwendungen zu nutzen, da es perspektivisch auslaufen wird!
    • synchronisieren live und werden von der FundraisingBox initiiert, d.h. die FundraisingBox verschickt immer dann einen Webhook, wenn es etwas "Neues" gibt
    • Webhooks gibt es für verschiedene Objekte, z.B. für Transaktionen oder für Daueraufträge
    • Die FundraisingBox gibt dann Bescheid, wenn es eine neue Transaktion gab oder sich etwas an der Transaktion geändert hat (z.B. Rückbuchung erkannt), dies passiert auf vorher definierten "events"
    • Webhooks sind immer nur in eine Richtung: FundraisingBox => Drittsystem (nie zurück)
    • => daher eigenen sich Webhooks für eine Live-Anbindung an ein Drittystem, z.B. externes CRM oder Marketing Automation Tool
    • Ihre Organisation oder Agentur gibt eine Webhooks-Empfangs-Adresse vor, an welche die FundraisingBox dann diese Webhooks sendet - die Verarbeitung und Interpretation der Daten erfolgt dann beim Drittsystem oder einer Schnittstelle
    • Einstieg unter: https://developer.fundraisingbox.com/reference/what-is-a-webhook
  • REST API:
    • Format: JSON
      • Wir bieten derzeit noch (das veraltete Format) XML parallel an, dieses ist jedoch nicht mehr empfohlen für neue Anwendungen zu nutzen, da es perspektivisch auslaufen wird!
    • hier erfolgt die Datenabfrage asynchron von dem Drittsystem oder einem Skript "von außen" und die FundraisingBox antwortet mit den passenden Daten/Informationen
    • auch hier gibt es bestimmte Datenpunkte, die angefragt werden können, z.B. alle Transaktionen (in einem gewissen Zeitraum) oder alle SEPA Mandate, usw.
    • REST API Anfragen können bidirektional sein, d.h. man kann damit sowohl Daten von der FundraisingBox auslesen, als auch diese schreibend verändern (z.B. eine Transaktion neu anlegen oder eine Kontakt-Adresse verändern, usw.)
    • => durch die asynchrone Verarbeitung (z.B. Abfrage nur 1x pro Tag) ist die REST API Schnittstelle nicht geeignet, um eine Live-Synchronisation aufzubauen
    • Einstieg unter: https://developer.fundraisingbox.com/reference/introduction-json

Hinweise zu REST API Tokens und Login-Anlagen

  • Die REST API Anfragen werden technisch über einen "Token" abgewickelt. Jeder FundraisingBox Login hat einen individuellen "Token".
  • Daher ist es sehr empfohlen, dass für Schnittstellen, bei denen die REST API verwendet wird, ein neuer und nur dafür genutzter Login von Ihrem Team angelegtwird, der ausschließlich für die REST API Schnittstelle genutzt wird! Dieser könnte daher z.B. so für Ihr Team eindeutig benannt werden:
    • Vorname: REST
    • Nachname: API
    • E-Mailadresse: Stimmen Sie mit Ihrer Agentur ab
    • Nutzerrechte:
      • Wir empfehlen hier dringend "least rights" umzusetzen, also nur die technisch für die API Schnittstelle nötigen Berechtigungen zu verwenden!
    • Hinweis: Der Login muss aktiviert werden (FundraisingBox Passwort muss binnen 24h nach Einladung gesetzt werden)
  • Token erhalten:
    • Wenn Sie die REST API-Schnittstelle verwenden möchten, wenden Sie sich bitte an unseren Support und teilen mit, welches Drittsystem Sie gerade anbinden und welche E-Mailadresse der REST API Login hat.

Hinweise zu Kontakt-Tags und benutzerdefinierten Feldern bei REST-API

  • Kontakt-Tags per REST API anlegen (aber nicht an Kontakte zweisbar):

  • Benutzerdefinierte Felder per REST API zuweisbar (aber nicht anlegbar)

    • Genau andersherum verhält es sich bei den "custom fields": Diese können per REST API nicht angelegt werden, aber ein Wert kann über die REST API bei den Objekten (z.B. Kontakte, Transaktionen, Daueraufträge, Spendenaktions-Felder) bearbeitet (z.B. hinzugefügt, geändert) werden.


War diese Antwort hilfreich? Ja Nein

Lassen Sie uns bitte wissen, wie wir diesen Beitrag verbessern können.