Dieses Kapitel beschreibt eine API, um externen Applikationen die Möglichkeit zu geben, in BACKCLICK vorhandene Abonnentenkonten mit deren Passwort abzufragen. Im Prinzip ist dies ein kleiner Authentifizierungsserver mit einer Basisfunktionalität. 

Aufgrund der Mandantenfähigkeit von BACKCLICK muss in jedem Aufruf des Authentifizierungs-Moduls die gewünschte Mandanten-ID übergeben werden. Sollte keine Mandanten-ID übergeben werden, wird der Aufruf dem Mandanten mit der ID=0 zugewiesen. 

! ACHTUNG SICHERHEIT ! 

Diese Interface kann ohne spezielle Einschränkungen von allen Servern, und Arbeitsstationen (IP Adressen) aufgerufen werden. Um dies einzuschränken, können Sie in Systemadministration --> Grundeinstellungen in der Rubrik 'Webinterface' die IP-Adressen angeben, von denen ein ausschließlicher Zugriff erlaubt wird. Aktivieren Sie dazu die Checkbox vor "Authentifizierungsmodul" und tragen rechts daneben in der Textarea die entsprechende/n IP Adresse/n ein. 

Folgende Funktionen werden von dieser API unterstützt: 

• Prüfung, ob eine übergebene Email-Adresse Abonnent im BACKCLICK System ist
• Prüfung, ob eine übergebene Email-Adresse Abonnent eines speziell angegebenen Newsletters (Verteilerliste) im BACKCLICK System ist
• Prüfung, ob die übergebene Email-Adresse und das übergebene Passwort in dieser Kombination auch in der BACKCLICK Datenbank vorhanden sind und ob das Passwort mit dem gespeicherten übereinstimmt

Sämtliche Funktionen werden über das HTTP-Protokoll aufgerufen. Zu jedem Aufruf wird ein Statuscode von BACKCLICK zurückgegeben. Die URL für die Kommunikation wird wie folgt gebildet: 

http://domain.kunde.de/bc/servlet/web.auth?............................. 

Als Parameter werden folgende Werte anerkannt: 

• EMAIL
• NEWSLETTER (ID der Verteilerliste/n)
• PASSWORD

Pflichtparameter sind grundsätzlich EMAIL und NEWSLETTER. 

Beispiel:

http://domain.kunde.de/bc/servlet/web.auth?EMAIL=m.mustermann@web.de&PASSWORD=passwort&MID=0

Fehlercodes: 

FEHLERCODE: 0 -> die Variable EMAIL wurde nicht angegeben, oder der Wert von EMAIL ist leer 

FEHLERCODE: 1 -> Email-Adresse & Passwort sind OK 

FEHLERCODE: 2 -> die angegebene Email-Adresse ist syntaktisch nicht korrekt 

FEHLERCODE: 3 -> die Variable PASSWORD wurde nicht angegeben 

FEHLERCODE: 4 -> das angegebene Passwort ist falsch, die Email-Adresse jedoch korrekt 

FEHLERCODE: 5 -> die angegebene Email-Adresse ist im System NICHT vorhanden 

FEHLERCODE: -100 -> Auth Funktion in den Systemeinstellungen deaktiviert, müsste aktiviert werden 

FEHLERCODE: -101 -> Konfiguration überprüfen. Konnte keine Verbindung zum API Server herstellen 

Beispiel:

http://domain.kunde.de/bc/servlet/web.auth?EMAIL=m.mustermann@web.de&PASSWORD=passwort&NEWSLETTER=1,2,33&MID=0

Hier finden die Statuscodes 6-9 Verwendung. Das Ergebnis wird standardmäßig für jede Verteilerliste folgendermaßen dargestellt: 

LISTEN-ID: STATUSCODE, 

wobei für jede übergebene Verteilerlisten-ID eine Zeile geschrieben wird. 

Bei syntaktischen Fehlern werden die FEHLERCODES 0, 2, 3 und 5 aus Fall 1 verwendet! 

Das Ergebnis des oben genannten Aufrufes (Fall 2) könnte beispielsweise so aussehen: 

1: 6 

2: 6 

33: 7 

Bedeutung der Statuscodes 6-9: 

6 -> Email-Adresse & Passwort OK, Abonnent hat Verteilerliste abonniert 

7 -> Email-Adresse & Passwort OK, Abonnent hat Verteilerliste NICHT abonniert 

8 -> das angegebene Passwort ist falsch, die Email-Adresse korrekt – Abonnent hat Verteilerliste abonniert 

9 -> das angegebene Passwort ist falsch, die Email-Adresse korrekt – Abonnent hat Verteilerliste NICHT abonniert 

10 -> Email-Adresse & Passwort OK, "double opt in" nicht bestätigt 

12 -> Email-Adresse & Passwort FALSCH, "double opt in" nicht bestätigt