Achtung
Experimentelles Feature
Dieses Feature ist in einem experimentellen Status. Falls euer Projekt Daten von einem Drittanbieter benötigt, wendet euch bitte direkt an support@bakehouse.at.
Was ist eine Remote Connection?
Es können Receiver Listen erstellt werden, die ihre Kontakte von einem Drittanbieter beziehen. Es kann zu einer Receiverliste eine URL hinterlegt werden, die zu einer API führt. Die API muss die Kontakte im JSON Format bereitstellen. Diese Daten können über die Remote-Connection importiert werden und im Anschluss können wie gewohnt Newsletter an die jeweilige Receiverliste versendet werden.
Vorraussetzungen
Remote Connections können nicht mit der Adressverwaltung kombiniert werden, d. h. alle Kontakte werden importiert, oder alle Kontakte werden manuell verwaltet. Anmeldungen für den Newsletter müssen in diesem Fall auch über den Drittanbieter erfolgen.
Alle TypoScript-Settings für die Remote Connection müssen an zwei unterschiedlichen Orten vorgenommen werden. Einmal im Root-TypoScript für den Versand und einmal im TypoScript der Newsletter Root Seite für das Interface.
Remote Connection
Aktivierung
Typoscript
plugin.tx_bhnewsletter.settings.remote = 1
Nachdem die Remote Connection aktiviert ist, wird die Adressverwaltung nicht mehr im Interface angezeigt. Zusätzlich erscheinen weitere Buttons oberhalb der Receiverlisten-Auswahl, die wie folgt näher beschrieben sind:
Funktionen
- Connect: Hier werden alle Receiverlisten, die eine Remote URL hinterlegt haben, importiert und in der Datenbank gespeichert.
- Resync: Alle Kontakte, die von einer Remote Quelle kommen, werden gelöscht und neu importiert.
- Disconnect: Alle Kontakte, die von einer Remote Quelle kommen, werden gelöscht.
Remote Connection Einstellungen
Disconnect nach abgeschlossenem Versand:
Wenn dieser TypoScript Parameter gesetzt wird, werden nachdem ein Newsletter bzw. alle Newsletter erfolgreich versendet wurden, alle importierten Kontakte automatisch gelöscht. Auch dieser Parameteter muss wie im Schritt "Vorraussetzungen" beschrieben an zwei Orten gesetzt werden.
Typoscript
plugin.tx_bhnewsletter.settings.remoteOptions {
disconnectAfterSend = 1
}
Schnittstelle und Format
Zu einer Receiverlist kann eine URL hinterlegt werden. Diese URL wird beim importieren herangezogen und für den Datenaustausch verwendet. Momentan wird nur ein einfacher HTTP Request unterstützt. Authentifizierungsmethoden können bei Bedarf über support@bakehouse.at angefragt werden. Der Response muss ein JSON mit der unten beschriebenen Struktur zurückliefern.
JSON Struktur
Das Feld email ist das einzige Pflichtfeld.
JSON
{
"contacts" : [
{
"email" : "address@example.com",
"name" : "Max Mustermann"
},
{
"email" : "address2@example.com",
"name" : "Sepp Musterhauser"
}
]
}
Verfügbare Felder
| Feld | Type | Beschreibung |
| string | Pflichtfeld - vor dem Speichern wird die E-Mail-Adresse validiert und im Fehlerfall wird der Kontakt nicht gespeichert. | |
| gender | string | |
| name | string | Wenn Name nicht befüllt, wird versucht, einen Namen aus Vor- und Nachname zu erstellen |
| first_name | string | |
| middle_name | string | |
| last_name | string | |
| birthday | integer | Unix Timestamp |
| title | string | |
| phone | string | |
| mobile | string | |
| www | string | |
| address | string | |
| company | string | |
| city | string | |
| zip | string | |
| country | string | |
| language | string | Zweistelliger Code (ISO 639-1) |