REST API
mynewsletter.rocks verfügt über eine RestAPI, mit der du eigene Empfängerlisten hochladen und dich automatisch einloggen kannst. Außerdem ist der Zugriff auf fast alle Protokolldaten möglich, die beim Versand von Newslettern anfallen. Auf diese Weise kannst du existierende Programme mit überschaubarem Aufwand um professionelle Funktionen für den Newsletter-Versand erweitern.
Einwahl & Authentizierung
Die Rest API von mynewsletter.rocks befindet sich im Verzeichnis https://app.de.mynewsletter.rocks/RestAPI/, die Authentizierung erfolgt über Benutzername und Passwort, wobei der Benutzername mit der Benutzerkennung des Kontos identisch ist.
Die Übertragung der Daten erfolgt grundsätzlich über https.
Funktionen
Die mynewsletter.rocks REST API hat im Moment die folgenden Funktionen. Weitere Funktionen können auf Wunsch hinzugefügt werden, bitte nimm hierfür Kontakt mit unserem Support auf.
GetAccountStatus()
Die Funktion GetAccountStatus gibt nach erfolgreichem Login folgende Daten zum Status des Benutzerkontos aus.
Rückgabewerte
Status
Bei erfolgreichem Login ist der Status ok, anderenfalls ist der Status error.
Content
Bei erfolgreichem Login in das Feld Content leer, anderenfalls wird eine Beschreibung des Login-Fehler ausgegeben.
TotalEmailCredits
Gibt die Anzahl der E-Mails zurück, die maximal innerhalb einer Abrechnungsperiode mit dem Nutzerkonto versendet werden können. Bei monatlichen Abonnements entspricht die Zahl dem E-Mail Volumen im Monat, bei Jahreskontingenten der maximalen gebuchten Anzahl von E-Mails im Jahr.
EmailCreditsUsed
Anzahl der in dieser Abrechnungsperiode versendeten E-Mails.
EmailCreditsLeft
Größe des für diese Abrechnungsperiode verbliebenen E-Mail Guthabens.
GetLoginToken()
Erzeugt nach erfolgreichem Login einen Einmal-Code, der für einen automatischen Login im Browser genutzt werden kann. Für die automatische Einwahl starten Sie den Browser mit der Url: https://app.de.mynewsletter.rocks/?tk=Token, wobei Token der mit dieser Funktion erzeugte Login-Token ist. Nach der Einwahl oder einem gewissen Zeitraum wird der Token automatisch wieder gelöscht, für eine erneute Einwahl muss ein neuer Token erzeugt werden.
Rückgabewerte
Status – Bei erfolgreichem Login ist der Status ok, anderenfalls ist der Status error.
ResponseCode – Ist die Anfrage erfolgreich hat der ResponseCode den Wert RDTokenCreated. Ist die Authentizierung fehlgeschlagen, ist der Wert Auth Error
Content – Beinhaltet den Login-Token.
GetJobs()
Die Funktion GetJobs gibt nach erfolgreichem Login eine Liste aller Mailings aus, die mit dem Nutzerkonto versendet wurden.
Rückgabewerte
Status – Bei erfolgreichem Login ist der Status ok, anderenfalls ist der Status error.
ResponseCode – Ist die Anfrage erfolgreich hat der ResponseCode den Wert ListOfJobs. Ist die Authentizierung fehlgeschlagen, ist der Wert Auth Error
Content – Beinhaltet die Liste der Mailings im JSON-Format mit den folgenden Feldern:
Status – Versandstatus
Deliver – Informationen über den Versand-Modus: entweder sofortiger Versand, Versand zu einem bestimmten Zeitpunkt, oder Versand zu einem bestimmten Zeitpunkt verteilt über x Stunden oder Tage.
JobID – ID des Mailings, beginnt mit dem Benutzernamen gefolgt von einem Unterstich und der fortlaufenden Nummer des Mailings.
Recipients – Anzahl der Empfänger
FROMAddress – E-Mail Adresse des Absenders
Subject – Betreffzeile
SubmitDate – Zeitpunkt, an dem das Mailing an den Server übergeben wurde.
GetLog()
Gibt ein Protokoll aus, beispielsweise für den Versand eines Mailings, die Click/View Daten oder die gesperrten Empfänger.
Parameter
JobID – ID des Jobs, für den das Protokoll geladen werden soll.
Link – Angabe des Links für den ClickOnLink Report.
Query – Bestimmt die Art des Protokolls. Folgende Protokolle stehen zur Auswahl:
AllInvalid – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, bei dem der Versand fehlgeschlagen ist.
DoNotEmail – Alle E-Mail Adressen, die in der Sperrliste enthalten sind.
ClicksOnAnyLink – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, die auf einen beliebigen Link geklickt haben
ClicksOnLink – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, die auf den im Parameter Link angegebenen Link geklickt haben
CompleteDoNotEmail – Alle E-Mail Adressen, die in der Sperrliste enthalten sind, samt Zeitpunkt der Abmeldung
GetClickedLinks – Liste aller Links, auf die im Parameter JobID angegebenen Mailings geklickt wurde.
OtherError – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, bei dem der Versand mit dem Fehler „Sonstiger Fehler“ fehlgeschlagen ist.
RelayDenied – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, bei dem der Versand mit dem Fehler „Annahme verweigert“ fehlgeschlagen ist.
UnknownHost – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, bei dem der Versand mit dem Fehler „Host unbekannt“ fehlgeschlagen ist.
UnknownUser – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, bei dem der Versand mit dem Fehler „Adresse unbekannt“ fehlgeschlagen ist.
Views – Protokoll aller Empfänger des im Parameter JobID angegebenen Mailings, die die E-Mail nachweislich geöffnet haben
Wird eine JobID, aber keine Query angegeben, wird das gesamte Protokoll des Mailings ausgegeben.
Rückgabewerte
Content – Beinhaltete das angefragte Protokoll im JSON Format.
Link – Der angegebene Link
JobID – Die angegebene JobID
Query – Die angegebene Query
ResponseCode – Ist die Anfrage erfolgreich hat der ResponseCode den Wert Log. Ist die Authentizierung fehlgeschlagen, ist der Wert Auth Error
Status – Bei erfolgreichem Login ist der Status ok, anderenfalls ist der Status error.
PostAddressList()
Lädt eine neue Empfängerliste auf den Server und importiert sie in das angegebenen Nutzerkonto.
Parameter
Content – Ein JSON Objekt mit den folgenden Eigenschaften
CategoryName – Name, unter dem die Empfängerliste auf dem mynewsletter.rocks Server gespeichert werden soll.
FieldList – Eine Liste der Feldnamen, getrennt mit Semicolon. Felder, die nicht auf dem Server vorhanden sind, werden automatisch als Text-Feld angelegt.
OverwriteCategory – Wenn der Wert true ist und eine Empfängerliste mit gleichem Namen existiert, wird die Liste überschrieben. Ist der Wert false und eine Liste gleichen Namens existiert, werden die Empfänger an die Liste angefügt.
RecipientList – Die Empfängerliste als JSON-Array
Rückgabewerte
Content – Beinhaltet eine Beschreibung des Fehlers wenn ein Import fehlgeschlagen ist.
CategoryID – ID, unter der die Empfängerliste gespeichert wurde. Mit dem Parameter selectlist= und einem Login-Token lässt sich automatisch ein Browserfenster öffnen, bei dem die exportierte Liste schon für den Versand ausgewählt ist.
RecordCount – Anzahl der Adresseinträge, die importiert wurden.
ResponseCode – War der Import erfolgreich, hat der ResponseCode den Wert Imported. Ist die Authentizierung fehlgeschlagen, ist der Wert Auth Error, ist der Import fehlgeschlagen, lautet der Wert Import Error, die Fehlerbeschreibung wird im Feld Content hinterlegt.
Status – Bei erfolgreichem Login ist der Status ok, anderenfalls ist der Status error.
