NEWSTROLL Hilfe & FAQ

# Die REST API nutzen

# JSON Web Token erstellen

Für den Aufruf der REST API (opens new window) ist ein Access-Token erforderlich. Wir verwenden ein JSON Web Token (opens new window) was im Authorization-Feld als Bearer-Token übertragen wird. Damit Sie ein individualisiertes Token erhalten legen Sie bitte einen neuen Benutzer mit API Rechten an:

API User anlegen

Das Token finden Sie nun bei den Details zum neu angelegten Benutzer:

Bearer Token

Verwenden Sie nun dieses Token im Authorization Header um einen API Aufruf durchzuführen.

Authorization: Bearer 1f319b0ec6aa2975e1a1d5464637949c

# Methoden und Objekte

Unsere REST API wird bei Bedarf um weitere Methoden und Objekte erweitert. Die folgenden Objekte stehen aktuell zur Verfügung.

Objekt URI Methoden
Empfänger /subscription Empfänger auslesen, anmelden und abmelden
Verteiler /group Verteiler abrufen und Einstellungen ändern
Personalisierung /personalization Personalisierungen anlegen und abrufen
Blacklist /blacklist Einträge abrufen, hinzufügen und löschen
Newsletter /newsletter Newsletter abrufen und erstellen

Hinweis

Das Objekt Personalisierungen liefert die in Ihrem Account angelegten Personalisierungen. Die tatsächlichen Personalisierungen beim Empfänger (zum Beispiel die korrekte Anrede) erhalten Sie beim Abruf der Empfänger.

Eine detaillierte Beschreibung aller Methoden und Parameter finden Sie in der Dokumentation auf Swaggerhub (opens new window). Hier können Sie auch direkt die API ausprobieren. Nutzen Sie dazu die Funktion "Authorize" oben rechts und dann "Tryout" bei der jeweiligen Methode.

Swaggerhub Dokumentation

# Beispiel

Ein einfaches Beispiel zum Abruf aller Verteiler könnte wie folgt aussehen:

$authorization = array('Authorization: Bearer 1f319b0ec6aa2975e1a1d5464637949c');
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.newstroll.de/group');
curl_setopt($curl, CURLOPT_HTTPHEADER, $authorization);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
print_r(json_decode($response, true));

Das Ergebnis sieht dann wie folgt aus:

Array
(
    [0] => Array
        (
            [id] => 74415
            [titel] => newstroll.de
            [name] => Kunden
            [publicgroup] => N
            [signonmail] => Y
            [commitment] => Y
            [signoffmail] => Y
            [signoffblist] => Y
            [commitsignon] => Y
        )
)

# Tools

Wir empfehlen Swagger.io (opens new window) oder Postman (opens new window) als Entwicklungstools.

←