Contao mit KlickTipp verbinden

[fenepedia/contao-klicktipp-gateway]

Mit dieser Erweiterung für Contao kannst du deine Kontakte von KlickTipp aktualisieren. Die Extension stellt dazu einen eigenen Gateway für das Notification Center bereit.

Aktueller Funktionsumfang

  • Hinzufügen neuer Kontakte zu KlickTipp
  • Aktualisierung bestehender Kontakte in der ContactCloud
  • Hinzufügen von Tags bei bestehenden Kontakten

Weitere Funktionen sind für zukünftige Versionen geplant. Du kannst die Weiterentwicklung gerne unterstützen. Hier findest du die Erweiterung bei GitHub.

Voraussetzungen

So setzt du die Erweiterung ein

1. Installation

Die Erweiterung kann kostenlos über den Contao Manager installiert werden.
Suche dazu nach der Erweiterung „fenepedia/contao-klicktipp-gateway“.

2. Neues Gateway anlegen

  1. Im Contao Backend anmelden
  2. Notification Center > Gateways > Neues Gateway
    • Titel: Name kann frei vergeben werden
    • Typ: KlickTipp API
    • Benutzername und Passwort von KlickTipp eintragen

Hinweise und Tipps:

  • Um die API zu nutzen, ist mindestens ein Premium-Account nötig
  • Den Benutzernamen findest du unter:
    KlickTipp > Mein Konto > Einstellungen > Benutzerkonto
  • Das Passwort ist identisch mit dem normalen Login ins KlickTipp-Konto
  • Bei KlickTipp Enterprise kannst du einen zusätzlichen Benutzer mit speziellen API-Rechten anlegen.

3. Neue Benachrichtigung erstellen

Notification Center > Benachrichtigungen > Neue Benachrichtigung

4. Aktion konfigurieren

Bei der soeben erzeugten Benachrichtigung muss nun eine "neue Nachricht" erstellt werden. Hier findet dann die Zuordnung der Felder von Contao und KlickTipp statt.

Unterschiede der API-Funktionen „subscribe“ und „signin“

Beide Methoden bieten effektive Wege, um neue Abonnenten zu gewinnen. Sie unterscheiden sich jedoch hinsichtlich ihres Einsatzbereichs und der jeweiligen Authentifizierungsschritte.
Weitere Informationen in der KlickTipp-Wissensdatenbank

4.1 Subscriber erstellen

  • Feld für E-Mail-Adresse festlegen
  • Double-Opt-In ID eintragen
    (leer = Default-Opt-In-Prozess, ggf. einen neuen Prozess anlegen)
  • Tag (optional)
    Unterstützt wird die eindeutige Tag-ID (empfohlen) und der Tag-Name
  • Zuordnung Contao Feldnamen mit KlickTipp Feldern
    • Wert = Contao Feld (##form_fieldname##)
    • Schlüssel = KlickTipp API-Feldnamen
  • Achtung: Die Feldnamen müssen zum entsprechenden Modul passen. Wenn du die Erweiterung bei "Mitglied: Registrierung" nutzt, dann lauten die Tokens statt ##form_feldname## entsprechend ##member_feldname##.

Hinweis: Sollte die E-Mail-Adresse bereits in den Kontakten von KlickTipp vorhanden sein, werden die Daten aktualisiert.

4.2 Signin erstellen

Im Gegensatz zur Funktion „Subscribe“ muss vorab in KlickTipp ein neues Listbuilding vom Typ „Eintragung per API-Key“ eingerichtet werden. Die Konfiguration des Opt-in-Prozesses sowie der Tags erfolgt anschließend direkt in KlickTipp.

  • Feld für die E-Mail-Adresse festlegen
  • API-Key des Listbuildings eintragen
  • Weitere Parameter zuordnen (optional)
    • Wert = Contao-Feld (##form_fieldname##)
    • Schlüssel = KlickTipp-API-Feldname

Achtung: Die Feldnamen müssen zum jeweils verwendeten Modul passen. Wird die Erweiterung bei „Mitglied: Registrierung“ eingesetzt, lauten die Tokens statt ##form_feldname## entsprechend ##member_feldname##.

4.3 Subscriber Update

Unterschied zur Subscriber-Aktion ist, dass der Kontakt nur aktualisiert wird, wenn dieser vorhanden ist. Sollte der Kontakt nicht vorhanden sein, wird nichts gemacht.

  • Feld für E-Mail-Adresse festlegen
  • Zuordnung Contao Feldnamen mit KlickTipp Feldern
    • Wert = Contao Feld (##form_fieldname##)
    • Schlüssel = KlickTipp API-Feldnamen

E-Mail-Adresse des Kontakt ändern

Per subscriber_update kann auch die E-Mail-Adresse des Kontakts geändert werden. Dazu muss als «Schlüssel» das Keyword «email» verwendet werden.

Achtung: eine Änderung der E-Mail-Adresse löst einen neuen Double-Opt-in-Prozess aus, was unter Umständen zur Austragung des Kontakts führt. Wenn du einen KlickTipp-Enterprise Account hast, dann kannst du dazu einen Single-Opt-In-Prozess definieren und die Option «für E-Mail-Adresse ändern verwenden» aktivieren.

4.4 Tag hinzufügen

  • Feld für E-Mail-Adresse festlegen
  • Tag vergeben oder dynamisch aus Formularfeld auslesen
    Unterstützt wird die eindeutige Tag-ID (empfohlen) und der Tag-Name

Es können auch mehrere Aktionen pro Nachricht erstellt werden. So kann z.B. ein Update der Daten und gleichzeitig auch ein zusätzlicher Tag vergeben werden.