close

Anmelden

Neues Passwort anfordern?

Anmeldung mit OpenID

150108 - Praktikum_Produktmanagement

EinbettenHerunterladen
API Dokumentation
v 3.1
Newsletter2Go
30. Oktober 2014
i
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Changelog
3.0 → 3.1
• Funktion Accountstatus abfragen hinzugef¨
ugt
2.9 → 3.0
• Funktion Gruppengr¨
oße abfragen hinzugef¨
ugt
2.8 → 2.9
• Funktion Newsletter abrufen hinzugef¨
ugt
2.7 → 2.8
• In der Funktion 4.1 Versenden einer Email ist der Parameter html nur noch optional, um auch
reine Text-Emails versenden zu k¨
onnen.
2.6 → 2.7
• Funktion Bounces abfragen hinzugef¨
ugt
2.5 → 2.6
• Funktion Gruppe l¨
oschen hinzugef¨
ugt
• Funktion Alle Empf¨
anger abrufen hinzugef¨
ugt
2.4 → 2.5
• Funktion Gruppe erstellen hinzugef¨
ugt
2.3 → 2.4
• Funktion Empf¨
anger aus Gruppe entfernen hinzugef¨
ugt
• Funktion Empf¨
anger abfragen hinzugef¨
ugt
2.2 → 2.3
• Funktion Gruppe leeren hinzugef¨
ugt
• Funktion Alle Gruppen von einem Newsletter entfernen hinzugef¨
ugt
2.1 → 2.2
• Funktion Gruppe zum Newsletter hinzuf¨
ugen hinzugef¨
ugt
• Funktion Gruppen eines Newsletters abrufen hinzugef¨
ugt
• Funktion Gruppe von einem Newsletter entfernen hinzugef¨
ugt
2.0 → 2.1
• Funktion Empf¨
anger in Gruppe einf¨
ugen hinzugef¨
ugt
1.9 → 2.0
• Funktion Abmeldungen abfragen hinzugef¨
ugt
ii
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
1.8 → 1.9
• Funktion Empf¨
anger l¨
oschen hinzugef¨
ugt
• Funktion Empf¨
anger erstellen erweitert um Double-Opt-In Verfahren
1.7 → 1.8
• Funktion mehrere Empf¨
anger erstellen (Batch) hinzugef¨
ugt
1.6 → 1.7
• Parameter category ist bei Emails nicht mehr notwendig.
1.5 → 1.6
• Funktion Credits abfragen hinzugef¨
ugt
1.4 → 1.5
• Funktion Empf¨
anger abmelden hinzugef¨
ugt
1.3 → 1.4
• Funktion Newsletter senden hinzugef¨
ugt
• Funktion Empf¨
anger setzen(Newsletter) hinzugef¨
ugt
• Funktion Attribut erstellen hinzugef¨
ugt
• Funktion Newsletter erstellen ge¨
andert (optionale Paramter hinzugef¨
ugt)
• neue Statuscodes hinzugef¨
ugt
1.2 → 1.3
• Funktion Attribut setzen hinzugef¨
ugt
• Funktion Newsletter abrufenhinzugef¨
ugt
• Funktion Webversion-Link abrufen hinzugef¨
ugt
• neue Statuscodes hinzugef¨
ugt
1.1 → 1.2
• Funktion Gruppen abrufen hinzugef¨
ugt
• Funktion Spezifische Merkmale abrufenhinzugef¨
ugt
• Funktion Formular key generieren hinzugef¨
ugt
• neue Statuscodes hinzugef¨
ugt
1.0 → 1.1
• Zwei neue Optionale Parameter (opentracking, linktracking) in der Email versenden Funktion
iii
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
0.9 → 1.0
• category ist neuer notwendiger Parameter beim Versenden einer Email
• Funktion Newsletter erstellen hinzugef¨
ugt
• Funktion Statistiken abrufen hinzugef¨
ugt
• Funktion Empf¨
anger erstellen hinzugef¨
ugt
• neue Statuscodes hinzugef¨
ugt
iv
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Inhalt
1 Allgemeines
1
2 R¨
uckgabewerte
2
3 Statuscodes
3
4 Versenden einzelner Emails / SMS
4.1 Versenden einer Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2 Versenden einer SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4
4
5
5 Newsletter-Management
5.1 Newsletter erstellen . . . . . . . . . . . . . . . . . .
5.2 Empf¨
anger zum Newsletter hinzuf¨
ugen . . . . . . .
5.3 Gruppe zum Newsletter hinzuf¨
ugen (auch gesamtes
5.4 Gruppen eines Newsletters abrufen . . . . . . . . .
5.5 Gruppe von einem Newsletter entfernen . . . . . .
5.6 Alle Gruppen von einem Newsletter entfernen . . .
5.7 Newsletter senden . . . . . . . . . . . . . . . . . .
5.8 Statistiken abrufen . . . . . . . . . . . . . . . . . .
5.9 Newsletter abrufen . . . . . . . . . . . . . . . . . .
5.10 einzelnen Newsletter abrufen . . . . . . . . . . . .
5.11 Webversion-Link abrufen . . . . . . . . . . . . . . .
. . . . . . . .
. . . . . . . .
Adressbuch)
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
7
7
7
8
8
8
9
9
10
10
11
11
6 Empf¨
anger-Management
6.1 Empf¨
anger erstellen . . . . . . . . . . . . . . . .
6.2 Empf¨
anger l¨
oschen . . . . . . . . . . . . . . . . .
6.3 mehrere Empf¨
anger erstellen (Batch) . . . . . . .
6.4 Attribut erstellen . . . . . . . . . . . . . . . . . .
6.5 Attribut setzen . . . . . . . . . . . . . . . . . . .
6.6 Spezifische Merkmale abrufen . . . . . . . . . . .
6.7 Gruppen abrufen . . . . . . . . . . . . . . . . . .
6.8 Empf¨
anger abmelden . . . . . . . . . . . . . . . .
6.9 Abgemeldete Empf¨
anger (unsubscribes) abfragen
6.10 Bounces abfragen . . . . . . . . . . . . . . . . . .
6.11 Empf¨anger in Gruppe einf¨
ugen . . . . . . . . . .
6.12 Gruppe leeren . . . . . . . . . . . . . . . . . . . .
6.13 Empf¨
anger aus Gruppe entfernen . . . . . . . . .
6.14 Empf¨
anger abfragen . . . . . . . . . . . . . . . .
6.15 Gruppe erstellen . . . . . . . . . . . . . . . . . .
6.16 Gruppe l¨
oschen . . . . . . . . . . . . . . . . . . .
6.17 Alle Empf¨
anger abrufen . . . . . . . . . . . . . .
6.18 Gruppengr¨
oße abfragen . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
12
12
13
13
14
14
15
15
15
15
16
16
17
17
17
18
18
18
19
7 Account Management
7.1 Abrufen der verf¨
ugbaren Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.2 Abrufen des Accountstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
20
20
v
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
1 Allgemeines
• Mit der Newsletter2Go API k¨
onnen Sie die wesentlichen Funktionalit¨aten von Newsletter2Go in
Ihre Anwendung integrieren.
• Die API orientiert sich am REST-Protokoll.
• S¨amtliche HTTP-Aufrufe m¨
ussen per POST durchgef¨
uhrt werden.
• Die R¨
uckgabewerte erfolgen stets im JSON-Format.
• Bei jeder HTTP-Anfrage m¨
ussen alle POST- n url-encoded u
¨bergeben werden, um eine korrekte
¨
Ubertragung und Verarbeitung gew¨
ahrleisten zu k¨onnen.
• S¨amtliche API-Anfragen m¨
ussen u
¨ber das SSL-Protokoll (HTTPS) laufen. Anfragen ohne SSL
sind nicht m¨
oglich.
Parameter
• S¨amtliche Parameter m¨
ussen url-encoded u
¨bergeben werden.
• Die Reihenfolge der Parameter ist beliebig.
• Die Parameter sind case-sensitive.
• Das keyword muss in Kleinbuchstaben u
¨bergeben werden.
1
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
2 R¨
uckgabewerte
S¨
amtliche R¨
uckgabewerte der Newsletter2go API erfolgen im JSON Format (application/json)
Es wird immer genau ein JSON-Objekt zur¨
uckgegeben, welches immer genau vier key-value-Paare
besitzt:
key
success
value
value-type
int
String oder null
value-example
0 or 1
status
int
200
reason
String
’OK’
description
1 means success, o means fail
returns a value in case of requests that will give a result, e.g. a newsletter id. Note: this is always a string,
even if a number is returned. This is null, if no value
is returned.
The status code which defines the response. For status
code explanations see section Statuscodes.
A textual representation of the status code
Ein Beispiel f¨
ur ein resultierendes JSON-Objekt w¨are:
{
success :0 ,
value : null ,
status :405 ,
r e a s o n : ” Method Not Allowed , POST R e q u i e r e d ”
}
2
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
3 Statuscodes
Die zur¨
uckgegebenen Statuscodes orientieren sich an den HTTP-Statuscodes.
200 ’OK’
201 ’Created’
400 ’Bad Request’
401 ’Unauthorized’
402 ’Not enough credits’
405 ’Method Not Allowed, POST required’
419 ’at least 1 required param missing’
420 ’unknown error’
421 ’type has wrong value’
422 ’“from” value required’
423 ’category has to be “basic” or “plus”’
425 ’name is empty’
426 ’date has bad value’
427 ’date is too big (only one year allowed)’
428 ’Newsletter ID has bad value’
429 ’at least one email address is not valid’
430 ’not allowed to send yet’
431 ’no statistics allowed for this newsletter (must be sent or created with api)’
432 ’newsletter id does not belong to you or it does not exist’
433 ’optional statistics parameter value has to be 0,1,true,false’
434 ’recipient needs email or mobile’
435 ’gender has to be m or f’
436 ’at least one url is not valid’
437 ’group id must be a number and greater than 0’
438 ’group does not exist’
439 ’attribute does not exist’
440 ’recipient does not exist’
441 ’recipient already exist’
442 ’not possible to send newsletter’
443 ’newsletter must be draft to add a recipient’
444 ’attribute already exists’
500 ’Internal Server Error’
3
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
4 Versenden einzelner Emails / SMS
Mit den folgenden Funktionen k¨
onnen sie einzelne Emails bzw SMS versenden. Dies ist n¨
utzlich um
z.B. Transaktionsmails zu verschicken oder wenn Sie Newsletter-Emails u
¨ber eine Schleife versenden
wollen.
4.1 Versenden einer Email
Um u
¨ber die Newsletter2Go API eine E-Mail versenden zu k¨onnen, setzen Sie aus Ihrer Anwendung
einen POST Request via HTTPS Protokoll an folgende URL:
https://www.newsletter2go.de/de/api/send/email/
ab.
Notwendige Parameter
Parameter
key
to
from
subject
text
html
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in Ihrem Account unter
“Einstellungen”.
Die Empf¨
anger-Emailadresse
Die Absender-Email-Adresse
Der Betreff der Email
Der Text-Part der Email. Wird dieser Parameter nicht angegeben, wird automatisch aus dem html - Teil ein Text-teil
erzeugt.
Der komplette HTML-Quellcode. Wird
dieser Parameter nicht angegeben, werden reine Text-Emails (plain/text) versendet.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@example.org
ihreAdresse@ihreDomain.de
Ihre Bestellung vom 23.05.2011
Hallo Freunde, ...
Ihr HTML-Quellcode
Bitte beachten Sie, dass nur einer der beiden Parameter text oder html notwendig ist.
Optionale Parameter
Parameter
id
debug
ref
Beschreibung
Die id des Newsletters
bei
Newsletter2Go.
Sie
wird ben¨
otigt, falls Sie die
Reporting-Funktionen von
Newsletter2Go u
¨ber die API
nutzen m¨
ochten.
Mit 1 Einschalten des
Debug-Modus.
Ist
der
Debug-Modus eingeschaltet,
k¨
onnen Sie die API von
Newsletter2go testen, ohne
dass die Email tats¨
achlich
versendet wird.
Eine eigene Referenz, die Sie
beliebig w¨
ahlen k¨
onnen.
Beispielwert
1453
Default-Wert
null
1
0
Januar2011
null
4
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
date
reply
linktracking
opentracking
Versenden der Email zeitversetzt. Es muss ein UNIXTimestamp
u
¨bergeben
werden. Liegt der Timestamp in der Vergangenheit,
ist er negativ oder leer wird
sofort versendet. Wird kein
valider
UNIX-Timestamp
u
¨bergeben, wird die Email
nicht
entgegengenommen
und Fehlercode 420 wird
zur¨
uck gegeben. Der Timestamp darf maximal 1 Jahr
in der Zukunft liegen.
Sie k¨
onnen eine alternative Reply-Adresse angeben.
Das ist die Email-Adresse,
an die eine Email geschickt
wird, wenn der Empf¨
anger
auf ¨
antworten”klickt.
Anbzw.
Abschalten
des Linktrackings. Standardm¨
aßig ist diese Option
eingschaltet.
Wird
das
Linktracking
abgeschaltet, werden Links nicht
umgeschrieben und damit
k¨
onnen Klicks auf Links
nicht registriert werden.
An- bzw. Abschalten des
¨
Offnungs-Tracking.
Standardm¨
aßig ist diese Option
eingeschaltet. Wird das
Opentracking
abgeschal¨
tet, werden Offnungen
der
Emails nicht registriert.
1306351118
Die aktuelle Zeit der Einlieferung der Email
noreply@example.org
Die from-Adresse.
0
1
0
1
4.2 Versenden einer SMS
Um u
¨ber die Newsletter2Go API eine SMS versenden zu k¨onnen, setzen Sie aus Ihrer Anwendung
einfach einen POST Request via HTTPS Protokoll an folgende URL:
https://www.newsletter2go.de/de/api/send/sms/
5
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
to
from
message
category
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Empf¨
anger-Mobilfunknummer
Die Absender-Kennung, nur notwendig, falls
category = plus
Der Text der Nachricht. Maximal sind 1530
Zeichen m¨
oglich.
Die Kategorie der SMS. Es stehen basic und
plus zur Auswahl
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
00491781234567890
Ihr Name
Lieber Peter, ich freue mich, dass ...
basic
Optionale Parameter
Parameter
from
id
ref
date
debug
Beschreibung
Dies ist die Absenderkennung
der SMS. Nur relevant, falls category = plus. Die Absenderkennung darf maximal 11 alphanumerische oder 16 numerische Zeichen enthalten. Hinweis:
Verzichten Sie auf Sonderzeichen
jeglicher Art, da sie nicht auf
jedem Mobilfunkger¨
at uneingeschr¨
ankt dargestellt werden.
Die id des Newsletters bei
Newsletter2Go.
Sie
wird
ben¨
otigt, falls Sie die ReportingFunktionen von Newsletter2Go
u
ochten.
¨ber die API nutzen m¨
Eine eigene Referenz, die Sie beliebig w¨
ahlen k¨
onnen.
Versenden der SMS zeitversetzt.
Es muss ein UNIX-Timestamp
u
¨bergeben werden. Liegt der
Timestamp in der Vergangenheit, ist er negativ oder leer
wird sofort versendet. Wird
kein valider UNIX-Timestamp
u
¨bergeben, wird die SMS nicht
entgegengenommen und Fehlercode 420 wird returned.
Mit 1 Einschalten des DebugModus. Ist der Debug-Modus
eingeschaltet, k¨
onnen Sie die
API von Newsletter2go testen,
ohne dass die SMS tats¨
achlich
versendet wird.
Beispielwert
Meine Firma
Default-Wert
1453
null
SMS-Angebot
null
1306351118
Die aktuelle Zeit der Einlieferung der SMS.
1
0
6
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
5 Newsletter-Management
Dieser Abschnitt beschreibt Funktionen, mit denen Sie ihre Newsletter bearbeiten k¨onnen. Sie k¨onnen
Newsletter erstellen, Empf¨
anger zu diesen hinzuf¨
ugen und den Newsletter dann abschicken. Desweiteren k¨onnen Sie sich die IDs aller Newsletter holen und dar¨
uber Statistiken abrufen.
5.1 Newsletter erstellen
Hier erstellen Sie ein Newsletter-Objekt, dem sp¨ater Inhalte und Empf¨anger zugewiesen werden k¨onnen
und der anschließend abgesendet werden kann. Um einen Newsletter u
¨ber die Newsletter2Go API zu
erstellen, setzen Sie einen POST Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/create/newsletter/
Dabei ist zu beachten, dass diese Funktion nur dazu da ist, eine Newsletter ID zu erzeugen und
zur¨
uckzuliefern.
Notwendige Parameter
Parameter
key
name
type
category
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Name des Newsletters (nicht der Betreff)
Der Typ des Newsletters. Es stehen sms und
email zur Auswahl
Die Kategorie der SMS. Es stehen basic und
plus zur Auswahl. Nur notwendig wenn type
== sms.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Newsletter 2011 Nr.1
sms
basic
Im zur¨
uckgegebenen JSON-Objekt wird in dem value Feld die erzeugte Newsletter ID zur¨
uckgeliefert.
Optionale Parameter
Parameter
subject
html
text
sms
from
reply
reference
Beschreibung
Betreff des Newsletters
Der
komplette
HTMLQuellcode
Der Text-Part des Newsletters
Der Inhalt f¨
ur einen SMS
Newsletter
Die
Absender-Email-Adresse
des Newsletters
Die Antwort-Email-Adresse des
Newsletters
Ein Referenzwert f¨
ur Ihren internen Gebrauch. Maximal 128
Zeichen.
Beispielwert
Newsletter Nr. 11
<html><body>Hallo Freunde,
<br/>...</body></html>
Hallo Freunde, ...
Hallo Freunde, ...
Default-Wert
null
null
from@yourdomain.de
null
reply@yourdomain.de
null
ID-47a
null
null
null
5.2 Empf¨
anger zum Newsletter hinzuf¨
ugen
Um einen Empf¨
anger zu einem Newsletter u
ugen, setzen Sie einen
¨ber die Newsletter2Go API hinzuzuf¨
POST Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/set/recipient/
7
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
id
email
mobile
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, zu der Sie einen Empf¨anger
hinzuf¨
ugen wollen.
Die Email-Adresse des Empf¨angers
Die Mobilfunknummer des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
recipient@example.org
123456789
Der Empf¨anger wird entweder u
¨ber das Attribut email oder das Attribut mobile identifiziert. Nur
eines von beiden ist obligatorisch. Es m¨
ussen nicht beide Attribute angegeben werden.
5.3 Gruppe zum Newsletter hinzuf¨
ugen (auch gesamtes Adressbuch)
Um eine Gruppe zu einem Newsletter hinzuzuf¨
ugen, setzen Sie einen POST Request u
¨ber HTTPS an
folgende URL:
https://www.newsletter2go.de/de/api/set/grouptonewsletter/
Notwendige Parameter
Parameter
key
nlid
groupid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, zu der Sie eine Gruppe hinzuf¨
ugen wollen.
Die Gruppe, die Sie zum Newsletter hinzuf¨
ugen wollen. Vorhandene Gruppen k¨onnen
Sie mit der Funktion 6.7 abrufen
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
11587
M¨ochten Sie einem Newsletter alle Empf¨
anger des gesamten Adressbuchs zuordnen, w¨ahlen Sie
als Wert f¨
ur groupid: -1.
5.4 Gruppen eines Newsletters abrufen
Um alle Gruppen, die bereits einem Newsletter zugeordnet wurden, abzurufen, setzen Sie einen POST
Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/groupsbynewsletter/
Notwendige Parameter
Parameter
key
nlid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, zu der Sie alle zugeordneten Gruppen abrufen wollen.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
5.5 Gruppe von einem Newsletter entfernen
Um die Zuordnung von einer Gruppe zu einem Newsletter zu entfernen, setzen Sie einen POST Request
u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/delete/groupfromnewsletter/
8
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
nlid
groupid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID des Newsletters, von dem
Sie eine Gruppe entfernen wollen.
Die Gruppe, die Sie vom Newsletter entfernen
wollen. Vorhandene Gruppen k¨onnen Sie mit
der Funktion 6.7 abrufen
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
11587
5.6 Alle Gruppen von einem Newsletter entfernen
Entfernt alle Gruppen die einem Newsletter zugeordnet wurden. Die Gruppen selbst werden nicht
gel¨oscht. Lediglich die Zuordnung wird entfernt.
https://www.newsletter2go.de/de/api/delete/allgroupsfromnewsletter/
Notwendige Parameter
Parameter
key
nlid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID des Newsletters, von dem
Sie alle Gruppen entfernen wollen.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
5.7 Newsletter senden
Um einen Newsletter u
¨ber die Newsletter2Go API abzusenden, setztn Sie einen POST Request u
¨ber
HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/send/newsletter/
Notwendige Parameter
Parameter
key
id
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, von dem zu sendenden
Newsletter
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
Optionale Parameter
Parameter
date
Beschreibung
Versenden des Newsletters zeitversetzt. Es muss ein UNIXTimestamp u
¨bergeben werden.
Liegt der Timestamp in der Vergangenheit, ist er negativ oder
leer wird sofort versendet. Wird
kein valider UNIX-Timestamp
u
¨bergeben, wird die Email nicht
entgegengenommen und Fehlercode 420 wird zur¨
uck gegeben.
Der Timestamp darf maximal 1
Jahr in der Zukunft liegen.
Beispielwert
1306351118
9
Default-Wert
Die aktuelle Zeit
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Mit dieser Funktion a
¨ndern Sie den Status des Newsletters auf Senden. Dadurch wird der Newsletter
versendet. Es k¨
onnen nur Newsletter versendet werden, deren aktueller Status Entwurf bzw. draft
oder api ist.
Ein Newsletter darf nur gesendet werden, wenn er mindestens einen Empf¨anger aufweist.
5.8 Statistiken abrufen
Um f¨
ur einen Newsletter Statistiken abzurufen, setzen Sie einen POST Request u
¨ber HTTPS an
folgende URL:
https://www.newsletter2go.de/de/api/get/statistics/
Das Antwort-JSON-Objekt enth¨
alt in dem value-Feld ein zweites JSON-Objekt, welches die StatistikWerte enth¨alt.
Da es sich um Verh¨
altnis-zahlen handelt, liegen sie zwischen 0 und 1 (z.B. 0.3 entspricht dann 30%).
Es ist aber auch denkbar, dass ein Wert gr¨oßer als 1 zur¨
uckgegeben wird (z.B. 2 entspricht dann 200%)
Die Bezeichnungen der Statistikwerte entsprechen den optionalen Parametern.
Notwendige Parameter
Parameter
key
id
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter-ID
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
3
Es sind nur Newsletter-Ids erlaubt, die zu Ihrem Account geh¨oren.
Optionale Parameter
Hier k¨onnen Sie w¨
ahlen, welche Statistik-Werte Sie abrufen wollen. Geben sie keine dieser Parameter
an, dann werden standardm¨
aßig alle Statistik-Werte zur¨
uckgegeben.
Die Auswahl der Statistik erfolgt u
¨ber einen boolschen Wert (0,1,true,false), wobei 1 und true bedeuten, dass der Wert zur¨
uckgegeben werden soll und 0 bzw. false bedeuten, dass er nicht zur¨
uckgeliefert
wird.
Parameter
recipients
uniqueOpenRate
openRate
notOpenRate
uniqueClickRate
clickRate
notClickRate
bounceRate
deliveryRate
Beschreibung
Anzahl der Empf¨
anger f¨
ur den Newsletter
¨
eindeutige Offungsrate
¨
¨
Offnungsrate
(enth¨
alt mehrfache Offnungen)
¨
Verh¨
altnis Nicht-Offnungen
zur Gesamt-Empf¨angerzahl
eindeutige Klickrate
Klickrate (enth¨
alt mehrfache Klicks)
Verh¨
altnis von Empf¨anger die nicht geklickt haben zur GesamtEmpf¨
angerzahl
Bounces im Verh¨
altnis zur Gesamt-Empf¨angerzahl
Gesamt-Empf¨
angerzahl - Bounces (Differenz)
Beispielwert
0
1
true
false
FALSE
TRUE
1
1
0
F¨
ur SMS-Newsletter ist nur der recipients-Parameter m¨oglich.
5.9 Newsletter abrufen
Um alle Ihre Newsletter u
¨ber die Newsletter2Go API abzurufen, setzen Sie einen POST Request u
¨ber
HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/newsletters/
10
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Diese Funktion ben¨
otigt nur den Api-Key und liefert ein Array, welches die Newsletter enth¨alt. Diese
Newsletter sind Abbildungen, die folgende Schl¨
ussel enthalten: id, state, html und name.
5.10 einzelnen Newsletter abrufen
Um einen bestimmten Newsletter u
¨ber die Newsletter2Go API abzurufen, setzen Sie einen POST
Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/newsletter/
Notwendige Parameter
Parameter
key
id
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, von dem Newsletter den
Sie abrufen moechten.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
Sie erhalten die Werte id, name, html und den aktuellen Status (state) des Newsletters.
Optionale Parameter
Parameter
fields
Beschreibung
Sie koennen angeben, welche Informationen Sie erhalten moechten.
Zur Auswahl stehen id, name, state und html. Diese k¨onnen kommagetrennt kombiniert werden
Beispielwert
id, state
5.11 Webversion-Link abrufen
Um den Link f¨
ur die Webversion f¨
ur einen Newsletter u
¨ber die Newsletter2Go API abzurufen, setzen
Sie einen POST Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/webversionlink/
Notwendige Parameter
Parameter
key
id
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Newsletter ID, dessen Webversion Sie abrufen wollen
11
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
456
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
6 Empf¨
anger-Management
Funktionen die hier als Empf¨
anger-Management bezeichnet sind, geben Ihnen die M¨oglichkeit ihre
Empf¨anger zu verwalten. Empf¨
anger und Empf¨angerattribute (Merkmale) k¨onnen erstellt werden.
Zus¨atzlich ist es m¨
oglich sich Attribute und Gruppen ausgeben zu lassen.
6.1 Empf¨
anger erstellen
Sie k¨onnen mit dieser Funktion Ihrem Newsletter2Go-Adressbuch neue Empf¨anger hinzuf¨
ugen.
Dies ist sinnvoll, wenn Sie z.B. automatisiert Ihr Shopsystem mit Ihrem Newsletter2Go-Adressbuch
synchronisieren wollen.
Wichtig: um einzelne (Transaktions-)Emails bzw. (Transaktions-)SMS u
¨ber diese API zu versenden,
ist es nicht notwendig Empf¨
anger vorher anzulegen.
Um einen einzelnen Empf¨
anger zu erstellen bzw. zu ihrem Adressbuch hinzuzuf¨
ugen, setzen Sie einen
Post Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/create/recipient/
Notwendige Parameter
Parameter
key
email
mobile
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Email-Adresse des Empf¨
angers
Handynummer des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@domain.de
0123456789
Es ist nur ein Parameter von email und mobile obligatorisch. Es k¨onnen aber auch beide Parameter
angegeben werden.
Optionale Parameter
Parameter
lastname
firstname
gender
doicode
group1
group2
Haarfarbe
Schuhgroesse
Beschreibung
Nachname des Empf¨
angers
Vorname des Empf¨
angers
Geschlecht des Empf¨
angers (m oder f)
Der Code des Double-Opt-In-Formulars
Gruppenzugeh¨
origkeit des Empf¨angers
Weitere Gruppenzugeh¨
origkeiten
Spezifische / Eigene Attribute
weiteres Attribut
Beispielwert
Mustermann
Max
m
ae0095fcc8ea8c8ae02170145d178
NewsletterLeser
W¨ahler
Schwarz
43
Es k¨onnen beliebig viele Gruppen und Attribute angegeben werden. Die Schl¨
ussel f¨
ur Gruppen m¨
ussen
mit group beginnen. Diese Schl¨
ussel m¨
ussen durchnummeriert werden.
Ein Attribut-Name darf nicht das Wort group enthalten. Attributnamen d¨
urfen keine Umlaute oder
Sonderzeichen enthalten.
Falls die Erstellung des Empf¨
angers per Double-Opt-In durchgef¨
uhrt werden soll und der Empf¨
anger
eine Double-Opt-In-Email erhalten soll, geben Sie den Parameter doicode an.
Diesen erhalten Sie, indem Sie sich im Frontend unter Einstellungen ein Anmeldeformular erzeugen.
Beispiel-JSON:
{
” key ” : a c b d 1 8 d b 4 c c 2 a s d c e d e f 6 5 4 f c c c 4 a 4 d 8 ,
” e m a i l ” : ” test@example . o r g ” ,
” f i r s t n a m e ” : ”Max” ,
12
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
” group1 ” : Mustermaurer ,
” group2 ” : ” Musterhandwerker ” ,
” H a a r f a r b e ” : ” Schwarz ” ,
” Bewertung ” : 4
}
Sind Attribute (z.B. Haarfarbe) nicht vorhanden, so werden sie neu angelegt. Dasselbe gilt f¨
ur Gruppen.
6.2 Empf¨
anger l¨
oschen
Sie k¨onnen mit dieser Funktion einzelne Empf¨anger aus Ihrem Newsletter2Go-Adressbuch l¨oschen.
Dazu setzen Sie einen Post Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/delete/recipient/
Notwendige Parameter
Parameter
key
email
mobile
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Email-Adresse des Empf¨
angers
Handynummer des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@domain.de
0123456789
Es ist nur ein Parameter von email und mobile obligatorisch. Es k¨onnen aber auch beide Parameter
angegeben werden.
Falls anhand der u
¨bergebenen Parameter kein Empf¨anger gefunden wird, wird trotzdem eine Erfolgsmeldung (200) zur¨
uckgegeben.
Der value-Wert der R¨
uckgabe beinhaltet die Anzahl der gel¨oschten Empf¨anger. Dies kann auch 0 sein.
6.3 mehrere Empf¨
anger erstellen (Batch)
Um mit einem API-Request mehrere Empf¨anger zu erstellen, setzen Sie einen Post Request u
¨ber
HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/create/recipients/
Notwendige Parameter
Parameter
key
recipients
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
zweidimiensionales Array im JSON-Format
welches die selben Parameter wie unter 6.1 f¨
ur
jeden Empf¨
anger beinhalten kann
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
s.u.
Ein Beispiel JSON-Input f¨
ur den Parameter recipients w¨are:
{
{’email’:’test1@example.org’,’firstname’:’Mike’,’gender’:’m’},
{’email’:’test2@example.org’,’Haarfarbe’:’blond’,’group1’:’meineapigruppe’},
{’email’:’test3@example.org’}
}
13
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Optionale Parameter
Parameter
id
temporary
Beschreibung
Newsletter-ID. Wird dieser Parameter u
¨bergeben, werden die neu
hinzugef¨
ugten Empf¨
anger dem Newsletter mit der u
¨bergebenen ID
zugeordnet. Der Newsletter muss noch im Entwurfs-Status sein.
1 oder 0. Wird dieser Parameter mit Wert 1 u
¨bergeben, werden alle
Empf¨
anger, die u
ugt wurden, nach
¨ber diesen Batch-Import hinzugef¨
dem Versand des Newsletters mit der oben angegebenen ID wieder
gel¨
oscht. Nur m¨
oglich in Verbindung mit dem zuvor angegebenen
Parameter id.
Beispielwert
123456
1
Es wird dringend empfohlen pro Request nicht mehr als 1000 Empf¨anger hinzuzuf¨
ugen. Weiterhin
darf die POST-Gr¨
oße nicht mehr als 20MB betragen, andernfalls wird der Request direkt von unseren
Servern abgelehnt.
Eventuell vorhandene Empf¨
anger werden automatisch aktualisiert.
Im zur¨
uckgegebenen JSON-Objekt enth¨alt der value-Wert die Anzahl der neu eingef¨
ugten Empf¨
anger.
Gr¨
unde f¨
ur nicht eingef¨
ugte Empf¨
anger k¨onnen u.a. sein: Empf¨anger existiert bereits, Email-Adresse
ist ung¨
ultig, o.¨
a.
6.4 Attribut erstellen
Um ein spezifisches Attribut u
¨ber die Newsletter2Go API zu erstellen, setzen Sie einen POST Request
u
ber
HTTPS
an
folgende
URL:
¨
https://www.newsletter2go.de/de/api/create/attribute/
Notwendige Parameter
Parameter
key
name
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Der Name des zu erstellenden Attributes
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Haarfarbe
Das Attribut darf nur Zeichen von a-z , A-Z und 0-9 enthalten. Andere Zeichen werden entfernt.
6.5 Attribut setzen
Um ein Attribut f¨
ur einen Empf¨
anger u
¨ber die Newsletter2Go API zu belegen, setzen Sie einen POST
Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/set/attribute/
Notwendige Parameter
Parameter
key
email
mobile
attribute
value
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Email-Adresse des Empf¨angers zu dem ein
Attribut gesetzt werden soll
Die Empf¨
anger-Mobilfunknummer zu der ein
Attribut gesetzt werden soll
Das Attribut, welches gesetzt werden soll.
Der Wert, den das Attribut erhalten soll
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@domain.de
0123456789
Vorname, Nachname, Alter
Max, Mustermann, 28
Die Standardattribute werden mit folgenden Bezeichnern angesprochen: firstname, lastname, mail,
mobile, gender. Anders benannte Attribute werden als spezifische Attribute angesehen.
Der Empf¨anger wird entweder u
¨ber das Attribut email oder das Attribut mobile identifiziert. Nur
eines von beiden ist obligatorisch. Es m¨
ussen nicht beide Attribute angegeben werden.
14
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
6.6 Spezifische Merkmale abrufen
Um Ihre Attribute u
¨ber die Newsletter2Go API abzurufen, setzen Sie einen POST Request u
¨ber
HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/attributes/
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Diese Funktion ben¨
otigt nur den Api-Key und liefert die Attribut Identifier und die dazugeh¨
origen
Namen.
6.7 Gruppen abrufen
Um Ihre Gruppen u
¨ber die Newsletter2Go API abzurufen, setzen Sie einen POST Request u
¨ber
HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/groups/
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Diese Funktion ben¨
otigt nur den Api-Key und liefert die Gruppen Identifier (ID) und die dazugeh¨
origen
Namen.
6.8 Empf¨
anger abmelden
Um einen Empf¨
anger als abgemeldet zu markieren, damit er nicht mehr angeschrieben werden kann,
setzen Sie einen POST Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/set/unsubscribed/
Notwendige Parameter
Parameter
key
email
mobile
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Email-Adresse des Empf¨angers
Die Mobilfunknummer des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@example.org
0049179123456789
Der Empf¨anger wird entweder u
¨ber das Attribut email oder das Attribut mobile identifiziert. Nur
eines von beiden ist obligatorisch. Es m¨
ussen nicht beide Attribute angegeben werden.
6.9 Abgemeldete Empf¨
anger (unsubscribes) abfragen
Um eine Liste von Email-Adressen aller abgemeldeter Empf¨anger abzufragen, setzen Sie einen POST
Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/unsubscribes/
15
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Der zur¨
uckgegebene value-Wert enth¨
alt ein Array mit den betreffenden Email-Adressen.
Optionale Parameter
Parameter
id
date from
date to
Beschreibung
Die ID des Newsletters, bei dem die Abmeldung erfolgt ist
UNIX Timestamp. Dieser Parameter erm¨oglicht es in Verbindung
mit date to die Abfrage auf einen Zeitraum zu beschr¨anken. Wird
date from gesetzt, muss auch date to gesetzt werden. date from
muss kleiner als date to sein.
UNIX Timestamp. Dieser Parameter erm¨oglicht es in Verbindung
mit date from die Abfrage auf einen Zeitraum zu beschr¨anken. Wird
date to gesetzt, muss auch date from gesetzt werden. date from
muss kleiner als date to sein.
Beispielwert
123456
1369560496
1369733296
Die optionalen Paramter id und date from bzw. date to k¨onnen auch kombiniert werden.
6.10 Bounces abfragen
Um eine Liste aller Email-Adressen abzufragen, an die keine Email zugestellt werden konnte (EmailHardbounce) setzen Sie einen POST Request u
¨ber HTTPS an folgende URL:
https://www.newsletter2go.de/de/api/get/hardbounces/
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Der zur¨
uckgegebene value-Wert enth¨
alt ein Array mit allen gebouncten Email-Adressen.
Optionale Parameter
Parameter
id
Beschreibung
Die ID des Newsletters, bei dem der Bounce erfolgt ist
Beispielwert
123456
Durch Angabe des optionalen Parameters id l¨asst sich die Abfrage auf einen einzelnen Newsletter
beschr¨anken. Es werden dann nur die Bounces zur¨
uckgegeben, die bei dem angegebenen Newsletter
aufgetreten sind.
6.11 Empf¨
anger in Gruppe einf¨
ugen
F¨
ugt einen bestehenden Empf¨
anger in eine bestehende Gruppe ein.
https://www.newsletter2go.de/de/api/set/recipienttogroup/
16
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
email
mobile
groupid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Email-Adresse des Empf¨angers
Die Mobilfunknummer des Empf¨angers
Die ID der Gruppe, in die der Epmf¨anger eingef¨
ugt werden soll. Sie k¨
onnen die IDs Ihrer
Gruppen mit der Funktion Gruppen abrufen
(6.7) abrufen.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@example.org
0049179123456789
2981
Der Empf¨anger wird entweder u
¨ber das Attribut email oder das Attribut mobile identifiziert. Nur eines
von beiden ist obligatorisch. Es m¨
ussen nicht beide Attribute angegeben werden. Falls der Empf¨
anger
bereits in der Gruppe vorhanden war, wird er nicht erneut eingef¨
ugt, es wird aber trotzdem 200 zur¨
uck
gegeben.
6.12 Gruppe leeren
Entfernt alle Empf¨
anger aus einer Gruppe. Die Empf¨anger selbst werden nicht gel¨oscht und verbleiben
im Adressbuch.
https://www.newsletter2go.de/de/api/delete/allrecipientsfromgroup/
Notwendige Parameter
Parameter
key
groupid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die ID der Gruppe, aus der alle Empf¨anger
entfernt werden sollen. Sie k¨onnen die IDs Ihrer Gruppen mit der Funktion Gruppen abrufen (6.7) abrufen.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
2981
6.13 Empf¨
anger aus Gruppe entfernen
Entfernt einen Empf¨
anger aus einer Gruppe. Der Empf¨anger selbst wird nicht gel¨oscht und verbleibt
im Adressbuch.
https://www.newsletter2go.de/de/api/delete/recipientfromgroup/
Notwendige Parameter
Parameter
key
groupid
email
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die ID der Gruppe, aus der der Empf¨anger
entfernt werden soll. Sie k¨onnen die IDs Ihrer
Gruppen mit der Funktion Gruppen abrufen
(6.7) abrufen.
Die Email-Adresse des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
2981
recipient@example.org
6.14 Empf¨
anger abfragen
Liefert folgende Informationen zu einem bestimmten Empf¨anger: E-Mail-Adresse, Handy-Nummer,
Vorname, Nachname, Geschlecht, Bounce-Status, Abmeldungs-Status, Gruppen, spezifische Attribute
(Merkmale).
17
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
https://www.newsletter2go.de/de/api/get/recipient/
Notwendige Parameter
Parameter
key
email
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Email-Adresse des Empf¨angers
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
recipient@example.org
6.15 Gruppe erstellen
Erstellt eine statische Gruppe mit Namen und Beschreibung (optional). Dynamische Gruppen k¨
onnen
nicht u
¨ber die API erstellt werden.
https://www.newsletter2go.de/de/api/create/group/
Notwendige Parameter
Parameter
key
name
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
der Name der Gruppe
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
meine API-Gruppe
Es k¨onnen nicht zwei Gruppen mit gleichem Namen existieren. Die R¨
uckgabe enth¨alt im value-Wert
die ID der neuen Gruppe.
Optionale Parameter
Parameter
description
Beschreibung
Beschreibung der Gruppe
Beispielwert
nur f¨
ur besondere Kontakte
6.16 Gruppe l¨
oschen
L¨oscht eine Gruppe. Die Empf¨
anger, die in dieser Gruppe sind, bleiben erhalten und werden nicht
gel¨oscht.
https://www.newsletter2go.de/de/api/delete/group/
Notwendige Parameter
Parameter
key
groupid
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die Gruppe, die Sie zum Newsletter hinzuf¨
ugen wollen. Vorhandene Gruppen k¨onnen
Sie mit der Funktion 6.7 abrufen
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
11587
6.17 Alle Empf¨
anger abrufen
Holt eine Liste aller aktiven Empf¨
anger (Bounces und Abmeldungen werden nicht abgerufen.). Die
Empf¨angerlisten werden paginiert abgerufen. Die Maximale Seiten-Gr¨oße ist 10000. Jede Antwort
enth¨alt die Anzahl aller abrufbaren Empf¨
anger, die Anzahl aller Seiten und die aktuelle Seite. So kann
einfach u
¨ber alle Seiten iteriert werden.
https://www.newsletter2go.de/de/api/get/recipients/
18
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Optionale Parameter
Parameter
page
recipients per page
order by
order type
Beschreibung
Die aktuelle Seite, die zur¨
uckgegeben werden soll.
Die erste Seite hat den Wert 0.
Die Anzahl der Empf¨anger pro Seite. Minimum
ist 100. Maximum ist 10.000
Das Empf¨
angermerkmal, das f¨
ur die Sortierreihenfolge verwendet wird. M¨oglich sind: id, created, gender, firstname, lastname, mail
Die Sortierreihenfolge. M¨oglich sind: ASC , DESC
Beispielwert
2
Default
0
5000
1000
created
id
DESC
ASC
6.18 Gruppengr¨
oße abfragen
Gibt die Anzahl der validen E-Mail-Empf¨anger (weder gebounced noch abgemeldet) einer Gruppe
zur¨
uck.
https://www.newsletter2go.de/de/api/get/groupsize/
Notwendige Parameter
Parameter
key
id
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in
Ihrem Account unter “Einstellungen”.
Die id der Gruppe.
19
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
43654
Version 3.1 vom 30. Oktober 2014, Feedback an dev@newsletter2go.de
7 Account Management
7.1 Abrufen der verf¨
ugbaren Credits
Sie k¨onnen Ihren aktuellen Credit-Stand abrufen, indem Sie aus Ihrer Anwendung einen POST Request
via HTTPS Protokoll an folgende URL absetzen:
https://www.newsletter2go.de/de/api/get/credits/
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in Ihrem Account unter
“Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Im zur¨
uckgegebenen JSON-Objekt enth¨
alt der value-Wert die verf¨
ugbaren Credits. Unterschieden
wird zwischen “freemailcount”(1000 Email-Credits kostenlos jeden Monat), “emailcount”(PrepaidEmail-Credits), “abocount”(Abo-Email-Credits), und “smscount”(SMS-Credits). Eine m¨ogliche Antwort w¨are:
{
’ success ’ : 1 ,
’ value ’ :
{
’ freemailcount ’ : 985 ,
’ emailcount ’ : 158820 ,
’ abocount ’ : 0 ,
’ smscount ’ : 173
},
’ status ’ : 200 ,
’ r e a s o n ’ : ’OK’
}
7.2 Abrufen des Accountstatus
Sie k¨onnen den aktuellen Accountstatus - ob der Account zum Versand freigegeben ist - abrufen, indem
Sie aus Ihrer Anwendung einen POST Request via HTTPS Protokoll an folgende URL absetzen:
https://www.newsletter2go.de/de/api/get/status/
Notwendige Parameter
Parameter
key
Beschreibung
Ihr Newsletter2Go API-Key. Sie finden ihn in Ihrem Account unter
“Einstellungen”.
Beispielwert
acbd1ddb4cc2f85cedasd54fccc4a4d8
Im zur¨
uckgegebenen JSON-Objekt enth¨alt der value-Wert die Information, ob der Account freigeschaltet (value=1) oder noch nicht freigeschaltet ist (value=0). Eine m¨ogliche Antwort w¨are:
{
’ success
’ value ’
’ status ’
’ reason ’
’ : 1,
: 1,
: 200 ,
: ’OK’
}
20
Document
Kategorie
Internet
Seitenansichten
18
Dateigröße
203 KB
Tags
1/--Seiten
melden