Versionen im Vergleich

Version Alte Version 22 Neue Version Aktuell
Änderungen wurden vorgenommen von

Adi Bärtschi

Jae-in Moon

Gespeichert am

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Beschreibung

...

Quelle

...

PerformX Adressen

...

Ziel

...

https://api.brevo.com/v3/contacts

...

Schnittstelle

...

Brevo API

...

Dokumentation Brevo

...

Getting started (brevo.com)

Inhalt
minLevel2
maxLevel2
outlinefalse
typelist
printablefalse

1. Konzept

Rollenaufteilung

  • Standardintegration von PerformX mit dem Newsletter-Tool Brevo via API von Brevo

  • Diese Schnittstelle wird mit dem PerformX-Connector realisiert und bietet die Möglichkeit, PerformX-Adressen für den Versand von Newslettern und Mailings direkt aus PerformX nach Brevo zu übertragen und zu aktualisieren

  • Das Führen und Administrieren der Segmentierung sowie auch die An-/Abmelde-Funktionen werden vollständig durch Brevo bereitgestellt. Es erfolgt keine Rückschreibung in PerformX

  • Brevo wird durch den Kunden, bzw. einen Drittpartner aufgesetzt, konfiguriert und betreut

...

  • Die gemäss Selektion definierten Adressen werden periodisch an Brevo übermittelt

  • Die von Brevo vergebene BrevoID wird im PerformX als Fremdschlüssel gespeichert, damit jederzeit eine Zuordnung möglich ist

  • Adressmutation übermittelter Adressen werden ebenfalls in Brevo aktualisiert

  • Löschungen und Inaktivierungen ??geschehen im Backend von Brevo

Versandlisten in Brevo

  • Aus PerformX werden zwei Versandlisten bedient:

    • Opt-In: Kontakte in dieser Liste müssen einen Opt-In-Prozess durchlaufen, bevor sie einen Newsletter erhalten

    • Newsletter: Kontakte in dieser Liste können direkt mit Newslettern beliefert werden, da sie den Opt-In-Prozess bereits auf einem anderen Weg durchlaufen haben

Initialimport

Für den erstmaligen Import der ausgewählten Adressen werden diese aus PerformX ex- und in die jeweils korrekte Liste in Brevo importiert. Der Connector synchronisiert anschliessend ausschliesslich die BrevoIDs der Adressen, welche in PerofrmX eine vordefinierte BrevoID eingetragen haben. Die Zuordnung erfolgt in diesem Fall über die in Brevo importierte E-Mail-Adresse und verschiedene E-Mail-Felder in PerformX.

Nach Abschluss des Initialimports werden die Zuordnungsdefinitionen auf Normalbetrieb eingestellt. Der Connector synchronisiert BrevoIDs nur, wenn das entsprechende Feld leer ist.

Bedingungen

...

  • Vor dem erstmaligen Export werden die definierten Adressen im PerformX markiert und in die entsprechende Brevo-Liste exportiert

  • Der Connector synchronisiert die BrevoID retour in PerformX, damit eine spätere Aktualisierung möglich ist

2. Schnittstellendefinition

Quelle

PerformX Adressen

Ziel

https://api.brevo.com/v3/contacts

Schnittstelle

Brevo API

Dokumentation Brevo

Getting started (brevo.com)

Bedingung für Erstellung neuer Kontakte in Brevo

Aktive

  • Nur aktive Adressen

Feld “E

  • Zu definierendes E-Mail-Feld (oder ein beliebiges E-Mail-

Newsletter”

  • Feld von mehreren in einer zu definierenden Reihenfolge) ist ausgefüllt

  • Buchung oder Adressmutation ab einem zu definierenden Stichtag vorhanden

  • Mutation seit der letzten Synchronisation oder noch nie übertragen

  • BrevoID null

    • (Aktiv == true) && (EMailNewsletter !? null && EMailNewsletter != '' ) && Relation.Count("Vertrag", "Datum \>= CreateDate(2022,1,1) && RolleID == 1") > 0 && EndOfDay(DatumMutation) > CurrentJob.LastSuccessfulExecution() && (BrevoID == null)

    Standard-

    • (keine BrevoID)

    Bedingung für Update in Brevo

    Aktive

    • Nur aktive Adressen

    • Adresse bereits an Brevo übertragen (BrevoID ausgefüllt)

    • Mutation seit der letzten Synchronisation

    (Aktiv == true) && (BrevoID != null) && (EndOfDay(DatumMutation) > CurrentJob.LastSuccessfulExecution())

    Vergabe Identifikation/Nummer

    Brevo

    Parameter Aufgabe

    --

    Konfiguration Connector

    ...

    Zuordnungsdefinition

    ...

    Name

    ...

    KUNDE: Brevo Contact-Sync

    ...

    Beschreibung/Notiz

    ...

    3. PerformX-Erweiterungen für Brevo

    Auf der Tabelle Adresse im Register “Info” wird ein zusätzliches Feld “Brevo ID” ergänzt (integer 8, standardmässig leer)

    4. Konfiguration Connector

    4.1 Benötigte Zuordnungen und Schnittstellen

    1. Übertrag Adressen ohne Opt-in-Prozess

    Name

    Kein Opt-In

    Sortierung

    1

    Quellobjekt

    AdresseFormel für Primärschlüsselfeld

    --

    Zielobjekt

    /contacts:createContact

    Mapping Mandanten

    Ein Mandant/eine Nummer pro Datensatz

    Synchronisations-Option

    Update oder Insert

    Daten nach Operation zurücklesen

    Ja

    Verwendeter Index

    --

    Felder (siehe Tabelle “Übertrag von PerformX nach Brevo)

    Alle

    Brevo-Listen-ID “listid”

    Gemäss Brevo Backend

    Zuordnung 22. Übertrag Adressen mit Opt-In-Prozess

    Name

    Mit Opt-In

    Sortierung

    2

    Quellobjekt

    Adresse

    Formel für Primärschlüsselfeld

    --

    Zielobjekt

    /contacts:createContact

    Mapping Mandanten

    Ein Mandant/eine Nummer pro Datensatz

    Synchronisations-Option

    Update oder Insert

    Daten nach Operation zurücklesen

    Ja

    Verwendeter Index

    --

    Felder (siehe Tabelle “Übertrag von PerformX nach Brevo)

    Alle

    Brevo-Listen-ID “listid”

    Gemäss Brevo Backend

    Zuordnung 33. Synchronisierung der Brevo-IDs nach PerformX

    Name

    Brevo-ID Synch

    Sortierung

    3

    Quellobjekt

    Adresse

    Formel für Primärschlüsselfeld

    --

    Zielobjekt

    /contacts/{email}:getContactInfo

    Mapping Mandanten

    Ein Mandant/eine Nummer pro Datensatz

    Synchronisations-Option

    Update oder Insert

    Daten nach Operation zurücklesen

    Ja

    Verwendeter Index

    --

    Felder (siehe Tabelle “Übertrag von PerformX nach Brevo)

    Alle

    Zuordnung 3

    4. Aktualisierung bestehender Adressen

    Name

    Update Contact

    Sortierung

    4

    Quellobjekt

    Adresse

    Formel für Primärschlüsselfeld

    --

    Zielobjekt

    /contacts:createContact

    Mapping Mandanten

    Ein Mandant/eine Nummer pro Datensatz

    Synchronisations-Option

    Update oder Insert

    Daten nach Operation zurücklesen

    JaVerwendeter Index

    --

    Felder (siehe Tabelle “Übertrag von PerformX nach Brevo)

    Alle

    Brevo-Listen-ID “listid”

    Gemäss Brevo Backend

    4.2 Feldmapping pro Schnittstelle

    ...

    1. und 2. Übertrag Adressen ohne Opt-in-Prozess und Übertrag Adressen mit Opt-in-Prozess

    Brevo Beschreibung

    PerformX Beschreibung

    Mapping/Übertrag an Brevo

    Beschreibung

    attributes[0].name

    Formel “LASTUPDATE”

    Selektiert Attribut “LASTUPDATE” in Brevo

    attributes[0].numeric

    DatumMutation

    1:1

    Überträgt ID nach attributes[0]

    attributes[1].name

    Formel “LASTNAME”

    Selektiert Attribut “LASTNAME” in Brevo

    attributes[1].text

    Name ??

    1:1

    Überträgt Name nach attributes[1]

    attributes[2].name

    Formel “FIRSTNAME”

    Selektiert Attribut “FIRSTNAME” in Brevo

    attributes[2].text

    Vorname ??

    1:1

    Überträgt Vorname nach attributes[2]

    attributes[3].name

    Formel “SALUTATION

    Selektiert Attribut “SALUTATION” in Brevo

    attributes[3].text

    Anrede.Anrede

    1:1

    Überträgt Vorname Anrede nach attributes[23]

    email

    berechnet aus verschiedenen Feldern (siehe nächste Spalte)

    Formel “EMailNewsletter ?? EMailD ?? EMail ?? EMailG”

    Überträgt berechnete E-Mail nach email (Reihenfolge ist gemäss Spezifikation anzupassen)

    listids

    --

    Formel ‘Listen-ID’ (siehe Zuordnungen oben)

    Listen-ID der Listen in Brevo

    attributes[4].name

    Formel “LANGUAGE”

    Selektiert Attribut “LANGUAGE” in Brevo

    attributes[4].text

    Sprache

    1:1

    Überträgt Sprache nach attributes[4]

    attributes[5].name

    Formel “DATEOFBIRTH”

    Selektiert Attribut “DATEOFBIRTH” in Brevo

    attributes[5].text

    Geburtsdatum

    1:1

    Überträgt Geburtsdatum nach attributes[5]

    attributes[6].name

    Formel “SMS”

    Selektiert Attribut “SMS” in Brevo

    attributes[6].text

    Natel

    1:1

    Überträgt Natel nach attributes[6]

    ...

    3. Synchronisierung der BrevoIDs nach PerformX

    ...

    Brevo Beschreibung

    PerformX Beschreibung

    Mapping/Übertrag an

    PerformX

    Brevo

    Beschreibung

    ID

    BrevoID

    --

    ...

    email

    berechnet aus verschiedenen Feldern (siehe nächste Spalte)

    Formel “EMailNewsletter ?? EMailD ?? EMail ?? EMailG”

    Überträgt berechnete E-Mail nach email (Reihenfolge ist gemäss Spezifikation anzupassen)

    id

    BrevoID

    1:1

    ID, die aus Brevo nach PerformX übertragen wird

    4. Aktualisierung bestehender Adressen

    Brevo Beschreibung

    PerformX Beschreibung

    Mapping/Übertrag an

    PerformX

    Brevo

    Beschreibung

    --

    attributes[0].name

    Formel “EMAIL”

    Selektiert Attribut “EMail” in Brevo

    attributes[0].text

    berechnet aus verschiedenen Feldern (siehe nächste Spalte)

    Formel “EMailNewsletter ?? EMailD ?? EMail ?? EMailG”

    Überträgt berechnete E-Mail

    für Synchronisation der BrevoID

    Definition Zielverbindung

    Name

    nach attributes[0] (Reihenfolge ist gemäss Spezifikation anzupassen)

    attributes[1].name

    Formel “LASTNAME”

    Selektiert Attribut “LASTNAME” in Brevo

    attributes[1].text

    Name ??

    1:1

    Überträgt Name nach attributes[1]

    attributes[2].name

    Formel “FIRSTNAME”

    Selektiert Attribut “FIRSTNAME” in Brevo

    attributes[2].text

    Vorname ??

    1:1

    Überträgt Vorname nach attributes[2]

    attributes[3].name

    Formel “SALUTATION

    Selektiert Attribut “SALUTATION” in Brevo

    attributes[3].text

    Anrede.Anrede

    1:1

    Überträgt Anrede nach attributes[3]

    attributes[4].name

    Formel “LANGUAGE”

    Selektiert Attribut “LANGUAGE” in Brevo

    attributes[4].text

    Sprache

    1:1

    Überträgt Sprache nach attributes[4]

    attributes[5].name

    Formel “DATEOFBIRTH”

    Selektiert Attribut “DATEOFBIRTH” in Brevo

    attributes[5].text

    Geburtsdatum

    1:1

    Überträgt Geburtsdatum nach attributes[5]

    attributes[6].name

    Formel “SMS”

    Selektiert Attribut “SMS” in Brevo

    attributes[6].text

    Natel

    1:1

    Überträgt Natel nach attributes[6]

    attributes[7].name

    Formel “LASTUPDATE”

    Selektiert Attribut “LASTUPDATE” in Brevo

    attributes[7].numeric

    DatumMutation

    1:1

    Überträgt ID nach attributes[0]

    email

    Formel “'{BrevoID}'“

    Setzt den Query-Parameter für den Abgleich

    4.3 Definition Zielverbindung Brevo

    Name

    KUNDE Brevo

    Verbindungsart

    OpenAPI

    Serveradresse

    https://api.brevo.com/v3

    Relativer Pfad zur OpenAPI Definition

    /swagger_definition.yml

    Client Secret

    Siehe Keeper

    Verbindungszertifikat überprüfen

    Ja

    Definition Quellverbindung

    Standardverbindung PerformX-Connector

    Aufgaben

    ...

    Name

    ...

    KUNDE: Brevo-Sync

    ...

    Zuordnungsdefinition

    ...

    Gemäss Tabelle oben

    ...

    Quellverbindung

    ...

    Gemäss Tabelle oben

    ...

    Zielverbindung

    ...

    Gemäss Tabelle oben

    ...

    Ausführungsplanung

    ...

    Gemäss Spezifikation

    ...

    Log Einstellung

    ...

    Immer

    ...

    Ausführungsmodus

    ...

    Vollständige Ausführung

    ...

    Max. Anzahl Datensätze

    ...

    --

    Konfiguration Brevo

    5. Konfiguration Brevo

    5.1 Notwendige Listen

    NameNameName

    Liste 1

    KUNDE_OptIn

    Liste 2

    identified_contacts

    Liste 2

    KUNDE_Newsletter

    5.2 Kontaktattribute

    Attributname

    Attributart

    EMAIL

    Text

    SALUTATION

    Text

    LASTNAME

    Text

    FIRSTNAME

    Text

    LANGUAGE

    Text

    DATEOFBIRTH

    Datum

    LASTUPDATE

    Datum

    DOUBLE_OPT-IN

    Kategorie

    SALUTATION

    Text