Aufruf
https://www.websale.de/api/emm/*
Es muss (wie bei der Dokumentation für die REST-Befehle für den AuthentServer beschrieben wurde) ein Token im Header übergeben werden.
Aktionen
Eintrag in die Sperrliste hinzufügen
Es kann eine Adresse neu zu der Sperrliste hinzugefügt werden. Dabei muss die eMail-Adresse und der Grund angegeben werden.
HTTP-Request
| Code Block |
|---|
POST https://www.websale.de/api/emm/addlock |
Content-Type
application/json
Authentification Token
benötigt
Request-Body
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| string | Email-Adresse, die zur Sperrliste hinzugefüt werden soll | |
| reason | string | Begründungstext wieso die Adresse zur Liste hinzugefügt werden soll |
Request-Body Beispiel
In diesem Beispiel wird die Adresse "beispiel@websale.de" zur Liste hinzugefügt, da der Adressinhaber dies telefonisch veranlasst hat.
| Code Block | ||
|---|---|---|
| ||
{
"email": "beispiel@websale.de",
"reason": "telefonisch veranlasst"
} |
Response
Bei Erfolg wird HTTP-Code 200 zurückgegeben. Der Content ist leer.
Ist ein Fehler aufgetreten wird ein 400er Code zurückgegeben.
Curl Beispiel
Die Adresse "beispiel@websale.de" wird zur Liste hinzugefügt, da der Adressinhaber dies telefonisch veranlasst hat.
| Code Block |
|---|
curl \
-X POST \
-H "Content-Type: application/json" \
-H "X-Authorization: Bearer eyJhbGciOiJIUzI1Ni...jBhOWMyMmRmNzFkOT==" \
-d '{
"email": "beispiel@websale.de",
"reason": "telefonisch veranlasst"
}' \
"https://www.websale.de/api/emm/addlock" |
Eintrag in der Sperrliste updaten
Wenn jemand z.B. die eMail-Adresse wechselt muss die Sperrliste (sofern die alte Adresse in der Sperrliste steht) um die neue Adresse erweitert werden.
HTTP-Request
| Code Block |
|---|
PUT https://www.websale.de/api/emm/changeemail |
Content-Type
application/json
Authentification Token
benötigt
Request-Body
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| oldadress | string | Alte Email-Adresse, nach der in der Sperrliste gesucht werden soll |
| newaddress | string | Neue Emal-Adresse, die in die Sperrliste eingetragen werden soll wenn die oldaddress in der Liste gefunden wurde |
Request-Body Beispiel
Der User hat die Email-Adresse von "beispiel@websale.de" in "neueadresse@websale.de" geändert. Diese soll mit in die Sperrliste eingetragen werden,
sofern die alte Adresse auch in der Liste steht.
| Code Block | ||
|---|---|---|
| ||
{
"oldaddress": "beispiel@websale.de",
"newaddress": "neueadresse@websale.de"
} |
Antwort
Bei Erfolg wird HTTP-Code 200 zurückgegeben. Der Content ist leer.
Ist ein Fehler aufgetreten wird ein 400er Code zurückgegeben.
Curl Beispiel
Der User hat die Email-Adresse von "beispiel@websale.de" in "neueadresse@websale.de" geändert. Diese soll mit in die Sperrliste eingetragen werden,
sofern die alte Adresse auch in der Liste steht.
...