Übermittlung von Daten via Schnittstelle / API

Cura besitzt eine REST Schnittstelle, an die Sie Daten im JSON Format senden können. Wenn z.B. Daten in Ihrem internen System aktualisiert werden, oder wenn Formularanfragen via Webseite erfasst werden, lassen sich diese Informationen dadurch automatisiert an Cura übermitteln.

Fakten zur Schnittstelle:

• HTTP Methode: POST
• Header Content-Type: "application/json"
• Header Authorization: "token <ID>"
• Body: JSON Payload
• Endpunkt: https://my.cura-fundraising.ch/api/latest/inbox/receiver/

Übermittelte Payloads werden im Menü «Postfach» dargestellt:

Detailansicht:

Payload

Der Standard Payload umfasst folgende Schlüssel:

    {
        "first_name":"Maxine",
        "last_name":"Musterfrau",
        "gender":"f",
        "language":"de",
        "phone":"+41613311570",
        "email":"maxine@muster.ch",
        "birthday":"1970-01-01",
        "extra_salutation":"Hey Maxi!",
        "use_personal_salutation":"yes",
        "locality":"Basel",
        "street":"Hauptstrasse 123",
        "country_code":"CH",
        "postcode":"4000",
        "membership_number":"12345678",
        "comment":"Anfrage via Kontaktformular",
        "info":"Mein Info-Text steht hier",
        "cura_tags":"Schlagwort Eins,Schlagwort Zwei",
        "key_value_pairs": {
            "schluessel":"wert"
        }
    }

Weitere JSON Parameter können zu Informationszwecken übermittelt werden. Sie haben keinen Einfluss auf die Verarbeitung, sind im Postfach aber ersichtlich.

Testaufruf / Identifikationsecho

curl -X GET https://my.cura-fundraising.ch/api/latest/who-am-i/?org=<ORGANISATION-SLUG>  -H 'Authorization: token <ID>'

Verarbeitung

Neue Kontakte werden ab den angelieferten Daten in der Regel automatisch erstellt, oder falls bereits vorhanden (Abgleich via Mitgliedsnummer oder Personentreffer), ergänzt. Ihre individuellen Anforderungen an die Verarbeitung und Automatisierung von Daten in Cura können via Support eingereicht werden. Im Anschluss erfolgen bei Bedarf weitere Abklärungen zu Ihren Anwendungsfällen und die notwendigen Anpassungen werden programmiert.

Es ist auch möglich über die ausgehende Cura-Schnittstelle Daten an ein externes System zu übermitteln. Der Datenumfang und die Verarbeitungslogik (Endpunkt, Prozesse) sind pro Organisation individuell zu definieren und zu programmieren.

Kontakt einer Kampagne hinzufügen und Spendenbrief erstellen

Wird dem Payload der Schlüssel "create_invoice" mit dem Wert "true" übermittelt, kann der Kontakt direkt einer Kampagne hinzugefügt und ein Spendenbrief erstellt werden. Die Angabe der gewünschten Kampagne erfolgt über die Kampagnen-ID (Payload Schlüssel "cura_campaign_id").

Neu erstellte Briefe werden täglich in einer Aufgabe gebündelt ("QR-Rechnungen vom XY") und dadurch als "Sammler" zum Download verfügbar gemacht. Zudem sind die erstellten Briefe auch unter "Downloads" auffindbar (oder direkt in der Kampagne unter "erreichte Kontakte").

Um diese Funktionalität nutzen zu können, müssen in den Kampagneneinstellungen folgende Optionen aktiviert werden:

• "QR-Rechnung automatisch erstellen, wenn Kontakte durch Workflows hinzugefügt werden."
• "Angedrucktes Datum darf automatisch verändert werden"

Einrichtung

Um Ihre Schnittstelle nutzen zu können, benötigen Sie einen Auth-Token (ID). Bitte wenden Sie sich an den Support.