Webstream.eu

Einführung

Über die Passwort-Schnittstelle, die Sie unten auf der Passwort-Profil-Seite finden, können Passwort-Eingaben für den Kanalzugriff extern geprüft werden. Die Schnittstelle übergibt die eingegebenen Daten, zurück gemeldet wird, ob der Zugriff gewährt werden darf oder nicht.

Sie haben dabei die Wahl, die Daten per GET-Parameter in einem URL-Aufruf oder im XML-Format als Webservice zu bekommen.

Möglichkeit 1) Übergabe als GET-Parameter

Die Übergabe als GET-Parameter stellt die 'einfachste' Möglichkeit dar. Sie geben in das Feld 'URL' die Adresse zu einem Script auf Ihrem Server ein. Aus Sicherheitsgründen, damit nicht beliebige URLs aufgerufen werden, muss die Datei in diesem Fall webauth.xxx heißen, z.B. webauth.php bei einem PHP-Script oder webauth.aspx im Fall eines ASP-Scripts. Angegeben wird der vollständige Pfad mit http:// oder https:// am Anfang.

GET-Parameter

GET-Parameter die beim Aufruf übergeben werden:
user : Der eingegebene Benutzername
passw : Das eingegebene Passwort
channel : Die Kanal-URL des Kanals, auf den sich der Login bezieht
profID : Profil-ID. Ein Integer Wert mit einer eindeutigen Passwort-Profil-ID. Diese ID bleibt gleich, auch wenn der Name des Passwort-Profils geändert wird. Das erste Passwort-Profil hat die ID 1, die Nummer wird dann fortlaufend erhöht. Aus der Browser-Oberfläche ist diese ID nicht ersichtlich.
guid : Ein von Ihnen festlegbares Passwort für die Schnittstellenbenutzung. Dieses prüfen Sie dann beim Aufruf Ihres Scripts.

Beispiel-Aufruf:
http://www.ihre-domain.de/webauth.php?user=Test&passw=XYZ&channel=kanal-url&profID=1&guid=passwort

Erwartete Rückgabe

Ihr PHP- oder ASP-Script sollte bei Verwendung von GET-Parametern folgendes zurück liefern:
ok : Benutzername und Passwort stimmen, Zugriff gewährt. Rückgabe ist der String 'ok', 2 Zeichen.
failUser : Benutzername existiert nicht. Rückgabe 'failUser' als String in der dargestellten Groß-Kleinschreibung.
failPassw : Passwort stimmt nicht. Rückgabe 'failPassw' oder alle anderen Rückgaben außer Leerstring, ok und failUser.

Zu beachten: Der Zugriff wird nur bei dem Rückgabestring 'ok' gewährt. Die Unterscheidung, ob der Benutzername existiert oder nicht, wird nur für das interne Zugriffsprotokoll verwendet, dem sich einloggenden Benutzer wird dies aus Sicherheitsgründen nicht angezeigt.

Möglichkeit 2) Übergabe im XML-Format als Webservice

Möchten Sie einen Webservice verwenden, so tragen Sie als URL die Adresse zu Ihrem Webservice ein. Die Adresse muss auf .asmx enden. Nur in diesem Fall wird der Parameter SOAP-Action verwendet und die Anfrage im XML Format gesendet.
Es muss ein Service 'Authenticate' unter der Adresse bereit gestellt werden.

Die Anfrage wird im XML-Format mit folgenden Parametern gesendet:
ViewerName : Der eingegebene Benutzername
ViewerPassword : Das eingegebene Passwort
ClientGUID : Die im Passwort-Profil eingegebene GUID. Sie dient dazu, Ihre Schnittstelle vor einem missbräuchlichen Aufruf zu schützen. Sie können eine GUID oder einen kurzen Passwort-String verwenden, den Sie dann im Webservice prüfen.
PasswordProfile : Der Name des Passwort-Profils
ChannelUrl : Die Kanal-URL des Kanals, auf den sich der Login bezieht

Beispiel
Im Folgenden sehen Sie eine Beispielanfrage mit der erwarteten beispielhaften Rückantwort.
Die Platzhalter werden in der Anfrage dann mit den tatsächlichen Parametern ersetzt.
POST http://www.ihre-domain.xyz/WebServices/AuthBroadcastViewerWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ihre-domain.xyz/Authenticate"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Authenticate xmlns="http://ihre-domain.de/">
<ViewerName>string</ViewerName>
<ViewerPassword>string</ViewerPassword>
<ClientGUID>string</ClientGUID>
<PasswordProfile>string</PasswordProfile>
<ChannelUrl>string</ChannelUrl>
</Authenticate>
</soap:Body>
</soap:Envelope>

Beispiel Rückantwort:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AuthenticateResponse xmlns="http://ihre-domain.de/">
<AuthenticateResult>int</AuthenticateResult>
</AuthenticateResponse>
</soap:Body>
</soap:Envelope>

Parameter der Rückantwort
AuthenticateResult : Ergebnis der Passwort-Prüfung
Mögliche Werte:
1 : Ungültiger Kanal-Name
2 : Ungültiger Benutzername (der Benutzer existiert nicht)
3 : Falsches Passwort
9 : OK - Zugriff gewährt

Sie können sich die jeweils zuletzt gesendete und empfangene Anfrage auch auf der Passwort-Profil Seite unter Letztes Ergebnis der Schnittstelle anzeigen lassen.