Rubrik: Schnittstellen / API, Formulare, An- und Abmelden, Einbindung in die Webseite

Schnittstelle zur externen Abfrage von Abonnenten-Daten

| Drucken |
Schnittstelle zur externen Abfrage von Abonnenten-Daten

Der folgende Artikel beschreibt die Abfrage von Empfängerdaten direkt aus Ihrer Liste, um z.B. Adressdaten direkt auf Ihrer Webseite oder in Ihrer Webanwendung anzuzeigen oder zu verarbeiten.

Diese Anleitung ist für Entwickler und Programmierer gedacht und setzt entsprechende Kenntnisse voraus.

Mithilfe dieser Schnittstelle können Sie Empfängerdaten direkt aus Ihrer Liste auslesen und diese dann zur Anzeige oder Weiterverarbeitung auf Ihrer Webseite oder in Ihrer Anwendung verarbeiten.

Dazu muss die Email-Adresse des Empfängers per GET-Request an diese URL übergeben werden:

https://xyz.frnl.de/api/subscriber/
(http ist ebenfalls möglich, aus Sicherheitsgründen aber nicht empfehlenswert)

xyz ersetzen Sie bitte durch die Nummer Ihres Servers, die Zahl ist identisch zu der in Ihrer Login-Adresse zum Control Center.

Parameter  
user Ihr Benutzername
list die ID der Liste, in der der Empfänger gespeichert ist. Sie finden die ID der Liste u.a. im Control Center, ganz oben bei "Aktuelle Liste: Listenname (ID: 1234)"
email die Email-Adresse des abzufragenden Empfängers
hash der Sicherheitshash. MD5-Hash aus Email-Adresse, Listen-ID und einem geheimen Schlüssel. Den geheimen Schlüssel vereinbaren Sie bitte vor der ersten Nutzung der API mit uns.
PHP-Beispiel-Code:

$hash = md5($email.$list.$secret)
unsubscribed [optional] zur ausschliesslichen Überprüfung, ob die Email-Adresse bereits früher abgemeldet war bzw. ist. Ergebnis im JSON Format:
Es erfolgt keine Rückgabe der anderen Feldwerte. Beispiel s.u.

Beispiel:
Um die Emailadresse "test@example.com" aus einer Liste mit der ID 555 auszulesen:

http://123.frnl.de/api/subscriber/?user=tester&list=555&email=test@example.com&hash=asdfhk234mbvl23534lkwemrgl2345we

Bei Erfolg erhalten Sie die Rückgabe im JSON-Format in der Form:


{
    "ID": "12345678",
    "Email": "test@example.com",
    "Name": "Mustermann",
    "subscribe_date": "2009-12-31",
    "subscribe_time": "13:14:15",
    "subscribe_ip": "12.34.56.78",
    "subscribe_status": "active",
    "Anrede": "Herr",
    "Vorname": "Max"
}


Leere Felder enthalten als Wert "null".

Rückgabewerte  
ID die interne ID der Email-Adresse
Email die Email-Adresse
Name der Name des Empfängers
subscribe_date Datum der Anmeldung im ISO-8601 Format
subscribe_time Uhrzeit der Anmeldung
subscribe_ip IP-Adresse, von welcher die Anmeldung erfolgte
subscribe_status 'unconfirmed' - Abonnent ist nicht aktiv (unbestätigte Email-Adresse, wird nicht zum Versand verwendet)
'active' - Empfänger ist aktiv (Single-Opt-In oder
bestätigt per Double-Opt-In)
weitere Feldnamen jedes angelegte Zusatzdatenfeld wird bei Vorhandensein von Werten ebenfalls ausgegeben

Bei einem Fehler erhalten Sie die Rückgabe im JSON-Format in der Form:

{
    "Error": {
        "Fehler-ID": "Fehlermeldung im Klartext"
    }
}

Parameter "unsubscribed":

Wenn der Parameter "unsubscribed" gesetzt ist (Übergabewert kann leer sein), wird nur überprüft, ob die Email-Adresse bereits früher abgemeldet war bzw. ist. Es erfolgt keine Rückgabe der anderen Feldwerte.

Beispielausgabe mit Parameter "unsubscribed", um zu prüfen ob die Email-Adresse "test@example.com" auf der Liste der Abgemeldeten steht:

http://123.frnl.de/api/subscriber/?user=tester&list=555&email=test@example.com&hash=asdfhk234mbvl23534lkwemrgl2345we&unsubscribed
{
  "email": "test@example.com",
  "unsubscribed": "yes",
  "note": "This email address has been unsubscribed from this list before."
}


Hinweis
:
Wenn Sie für eine Liste die Anmeldung von Duplikaten zugelassen haben, wird mit der Abfrage immer nur der jeweils erste gefundene Datensatz ausgegeben (in der Regel der zeitlich zuerst eingetragene Empfänger).

Sie können die Schnittstelle aus Ihrer Webanwendung aufrufen, mit PHP beispielsweise einfach per fopen(), file_get_contents() oder mithilfe der cURL-Bibliothek.
Die Rückgabe lässt sich dann leicht z.B. per json_decode() in ein Array konvertieren

Für Sonderwünsche oder spezielle Fragen kontaktieren Sie uns bitte - wir haben schon für eine Vielzahl von Anwendungen spezielle Schnittstellen und Lösungen für unsere Kunden geschaffen.

War dieser Artikel hilfreich?

Ja Nein