PORTAL und PPS Knowledge Base
Newsletter API
- Franziska Franz
- Ilker Oygün
- Former user (Deleted)
Mithilfe der PEIQ Cloud-Connect APIs (engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff wird dabei über die Standard HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.
Die API des Newsletter-Moduls kann zum Abrufen, Anlegen und Löschen von Abonnements registrierter Benutzer:innen oder unregistrierter Besucher:innen genutzt werden.
Funktionalitäten der Newsletter API
Abrufen von Newsletter-Abonnements
Anlegen von Newsletter-Abonnements
Löschen von Newsletter-Abonnements
Inhaltsverzeichnis
Nutzung des Newsletter-Moduls mit Newsletter API zum Anschluss von externen Systemen
Beim E-Mail Marketing profitieren Unternehmen von der Möglichkeit, ihre Kund:innen individuell ansprechen zu können und dadurch eine hohe Nutzerbindung aufzubauen. Das Newsletter-Modul unterstützt diese Form des Marketings, indem es die eigene E-Mail-Marketing-Strategie effizient mit dem PEIQ PORTAL verschneidet und somit die Bindung von Organisationen und Lesern nachhaltig und ohne Mehraufwand sichert. Das Newsletter-Modul ist dabei auf Conversions von Newsletter-Abonnements fokussiert: Wird ein Newsletter ausgewählt, werden die Benutzer:innen über die Newsletter API an das externe Newsletter-Tool übergeben.
Für die Anbindung eines externen Newsletter-Tools an das PEIQ PORTAL über die Newsletter API sind entsprechende Programmierkenntnisse zwingend erforderlich.
Grundlegendes zur Newsletter API
Mithilfe der Newsletter API können externe Newsletter-Tools an das PEIQ PORTAL angebunden werden, um hierüber Newsletter-Abonnements von registrierten Benutzer:innen oder unregistrierten Besucher:innen abzurufen, anzulegen und zu löschen.
Verfügbare Endpunkte für Newsletter
Im PORTAL können mehrere Newsletter hinterlegt werden, diese können über den folgenden Endpunkt mit diversen Filtern gelesen werden.
status:GET
Get All Newsletters
Get Newsletter by newsletter_id
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"name": "Job Newsletter",
"remote_id": 1432,
"sync_date": "2019-03-09T02:00:00+00:00"
}
]
}Verfügbare Endpunkte für Subscriptions
Benutzer:innen, die einen Newsletter abonnieren, werden vom System als Subscription gespeichert. Über folgende Endpunkte können Subscriptions gelesen, erstellt oder auch gelöscht werden.
status:GET
Get All Newsletter Subscriptions by newsletter_id
Get Newsletter Subscriptions
Get Newsletter Subscriptions by subscription_id
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"updated": "2015-03-07T03:00:00+00:00",
"status": "not_verified",
"email": "max@mustermann.de",
"first_name": "Max",
"last_name": "Mustermann",
"user_id": 1,
"newsletter_id": 1,
"verify_token": "ad35e073e36e0f7626dc4197e7beaa57",
"remote_id": 1432
}
]
}status:POST
Create Newsletter Subscription
status:DELETE
Delete Newsletter Subscription by subscription_id
Request Body
{
"email": "max@mustermann.de",
"first_name": "Max",
"last_name": "Mustermann",
"user_id": 1
}Abmeldung direkt über Verify-Token
Über die Newsletter API kann die ID sowie der Verify-Token einer Subscription über den status:GET-Endpunkt abgerufen werden.
Mit der ID und dem Token kann der spezifische Abmelde-Link selbst gebaut werden:
https://example.com/newsletter/subscription/verify-remove/subscription-ID?token=560b88a23e9b9457f56f0df0794e2989Mit Klick auf den Link werden die Benutzer:innen direkt vom Newsletter abgemeldet und auf die Bestätigungsseite weitergeleitet. Der Status des deabonnierten Abonnements wird auf
"status": "unsubscribed"aktualisiert.
Trouble Shooting bei HTTP Status Codes
400 - Bad Request
404 - Not Found
Verwandte Seiten
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/jwC-AQ