Konnektoren
Schemaobjekte
Die SQL- und Dateibrücke
Das OAuth 2.0 Verfahren
Gesperrte Datensätze

CleverReach Konnektor

CleverReach ist ein Cloud-basiertes E-Mail-Marketing-Tool für den Versand, die Segmentierung und die Auswertung von Kampagnen.
Der Konnektor integriert CleverReach über die REST API (Version 3) in Syncler und ermöglicht den Austausch von Empfänger- und Mailing-Daten sowie die Archivierung von Ergebnissen und Reports.

Voraussetzungen

Um den Konnektor einzurichten, benötigen Sie einen aktiven CleverReach-Account und Zugriff auf die REST API.

  1. Melden Sie sich im CleverReach-Portal an.
  2. Navigieren Sie zu:
    • Mein Account
    • Extras
    • REST API
  3. Erstellen Sie eine neue OAuth-App:
    • Vergeben Sie einen Namen für die App.
    • Wählen Sie die REST API Version 3.
    • Aktivieren Sie die erforderlichen Scopes:
      • Empfänger (für Empfänger-Übertragungen)
      • Report (für den Abruf von Kampagnen-Ergebnissen)
  4. Speichern Sie die App und öffnen Sie erneut den Bearbeitungsdialog (3-Punkte-Menü).
  5. Wechseln Sie zum Reiter „Oauth2 App Daten“.
    • Übernehmen Sie die Client ID und das Client Secret in die Syncler-Systemmaske.
  6. Erzeugen Sie den Refresh Token:
    • Klicken Sie auf „Prozess jetzt testen“.
    • Melden Sie sich erneut mit Ihren CleverReach-Zugangsdaten an.
    • Kopieren Sie den generierten Refresh Token in die Systemeinstellungen.

⚠️ Wichtige Hinweise:

  • Der Refresh Token ist 30 Tage gültig.
  • Bei aktiver Nutzung erneuert Syncler den Token automatisch.
  • Wird das System länger als 30 Tage nicht genutzt, muss ein neuer Token manuell über „Prozess jetzt testen“ erzeugt werden.

Einrichtung

Für die Einrichtung des Konnektors sind folgende Werte erforderlich:

Client ID

  • ID der CleverReach OAuth-App.

Client Secret

  • Geheimschlüssel der CleverReach OAuth-App.

Refresh Token

  • Der aktuelle Refresh Token (wird bei aktiver Nutzung automatisch erneuert).

Gruppen-ID (optional)

  • Definiert die Standardgruppe für Empfänger.
  • Aktiviert zusätzlich die Nutzung von gruppenspezifischen Attributen.

Tags als Freitext (optional)

  • Schaltet die Verarbeitung von Tags im Freitextfeld (tags) ein.
  • Vorteil: neue Tags stehen automatisch zur Verfügung.
  • Nachteil: für Auswertungen und Transformationen ist zusätzliche Verarbeitung erforderlich.

Objekte

Das Schema wird durch den Konnektor erstellt und umfasst folgende Strukturen:

  • Empfänger-Schema

    • Wird um benutzerdefinierte globale Attribute erweitert.
    • Enthält die Gruppen-ID zusätzlich zur Empfänger-ID, da Gruppenattribute nur mit beiden Identifikatoren nutzbar sind.

  • Gruppenattribute

    • Werden in einer eigenen Objektgruppe verfügbar, sobald eine Gruppen-ID in den Systemeinstellungen hinterlegt ist.

  • Tags

    • Zwei Verfahren stehen zur Verfügung:
      1. Tags als Felder:
        • Vorhandene Tags werden als einzelne Felder im Schema ergänzt.
        • Bei neuen Tags muss das Schema manuell aktualisiert werden.
      2. Tags als Freitext:
        • Alle Tags werden in einem Feld (tags) als komma- oder leerzeichengetrennter Text gespeichert.
        • Neue Tags stehen automatisch zur Verfügung.
        • Für die Verarbeitung werden meist Transformationen benötigt.

Lesen von Daten

Das Lesen von Daten erfolgt über die REST API.

Gruppen

  • Können einzeln oder als Liste gelesen werden.
  • Änderungsabfragen sind möglich.
  • ⚠️ Filter sind nicht verfügbar.

Mailings

  • Können einzeln oder als Liste gelesen werden.
  • Änderungsabfragen werden unterstützt.
  • Folgende Feldparameter sind zusätzlich nutzbar:
    • limit
    • channel_id
    • state
    • start
    • end

Empfänger

  • Können einzeln oder als Liste gelesen werden.
  • Eine Gruppe muss angegeben werden (über Systemeinstellungen oder spezialisierte Syncs).
  • Wenn keine Gruppe angegeben ist:
    • Syncler ruft zuerst alle Gruppen und anschließend alle zugehörigen Empfänger ab.
  • Einschränkungen:
    • Empfänger besitzen kein Änderungsdatum → Änderungsübertragungen aus CleverReach sind nicht möglich.
    • Das Registrierungsdatum des Empfängers wird als Änderungsdatum genutzt → dadurch können kontinuierlich neue, aber keine geänderten Empfänger abgerufen werden.
  • Nur über spezialisierte Syncs oder SDK-Syncs abrufbar.
  • Steuerung über die Parameter:
    • GETDATA_RELATED (Werte: groups, mailings, reports)
    • GETDATA_RELATED_ID (ID des übergeordneten Objekts)

Schreiben von Daten

  • Schreiben erfolgt über die REST API.
  • Unterstützt:
    • Anlegen neuer Empfänger
    • Aktualisieren bestehender Empfänger
  • Spezialisierte Syncs bieten zusätzlich ein UPSERT-Verfahren, um Listen von Empfängern effizient abzugleichen.

⚠️ Einschränkungen:

  • Bulk-Operationen werden nicht nativ unterstützt.
  • Bei Dubletten (z. B. gleiche E-Mail-Adresse) kommt es zu Fehlern, wenn kein UPSERT-Sync verwendet wird.

Besonderheiten

  • Der Konnektor eignet sich besonders für Synchronisationsszenarien mit CRM-Systemen (z. B. Sage CRM, Zoho CRM, CAS genesisWorld).
  • Durch die Unterstützung von Tags und Gruppenattributen ist eine flexible Segmentierung der Empfänger möglich.
  • ⚠️ Einschränkung: Geänderte Empfänger können nicht direkt erkannt werden.
    • Workaround: Nutzung des Registrierungsdatums in Kombination mit Transformationen oder zusätzlichen Sync-Strategien.