aoRestServer/ODATA
12 Funktionen für den Webuser
Für die Anmeldung als Webuser steht der aus der ABES/Objects-COM-Server Dokumentation bekannte Satz an Funktionen bereit.
Diese werden hier im Einzelnen für ihre Verwendung in der OData-Schnittstelle erläutert.
Für das Ausführen aller Webuser-Funktionen muss ein gültiges Authentifizierungs-Token des Servers im Request mitgegeben werden.
- Funktion WebuserLogin
- Funktion WebuserLogout
- Funktion WebuserRegister
- Funktion WebuserSetPassword
- Funktion WebuserReset
- Funktion Webuser
1. Funktion WebuserLogin
Diese Funktion dient der Anmeldung eines Webusers. Die Übergabe der erforderlichen Parameter kann über die Url oder im Header des Requests erfolgen.
|
Parametername |
Parametertyp |
|
Username |
string |
|
Password |
string |
Direkt mittels Url
|
Request |
|
|
GET |
http://test.server.de/odata/WebuserLogin( Username=’name’, Password=’pwd’) |
Über den Request Header
Username und Passwort werden hier im Header WebuserCredentials in der Form name:pwd Base64 codiert übergeben. Insbesondere bei Verwendung von SSL/HTTPS sollte diese Methode der Anmeldung aus Sicherheitsgründen Anwendung finden. Außerdem machen manche Sonderzeichen im Passwort die Nutzung der Authorization-Header-Angabe notwendig.
|
Request |
|
|
Header |
WebuserCredentials: bmFtZTpwd2Q= |
|
GET |
http://test.server.de/odata/WebuserLogin |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Edm.String”, “value”: true } |
2. Funktion WebuserLogout
Diese Funktion dient dem expliziten Abmelden eines Webusers.
|
Parametername |
Parametertyp |
|
— |
— |
Aufruf
|
Request |
|
|
GET |
http://test.server.de/odata/WebuserLogout() |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”, “value”: true } |
3. Funktion WebuserRegister
Diese Funktion dient dem erstmaligen Registrieren eines Webusers. Die Übergabe der erforderlichen Parameter kann über die Url oder im Header des Requests erfolgen.
|
Parametername |
Parametertyp |
|
RegKey |
string |
|
Username |
string |
|
Password |
string |
Direkt mittels Url
Es ist darauf zu achten, dass der Registrierungskey korrekt URL-enkodiert wird.
|
Request |
|
|
GET |
http://test.server.de/odata/WebuserRegister( RegKey=’12abcd’, Username=’name’ Password=’pwd’) |
Über den Request Header
RegKey, Username und Passwort werden hier im Header WebuserCredentials in der Form regkey:name:pwd Base64 codiert übergeben. Insbesondere bei Verwendung von SSL/HTTPS ist diese Methode der Anmeldung aus Sicherheitsgründen gegenüber der mittels Url vorzuziehen.
|
Request |
|
|
Header |
WebuserCredentials: MTJhYmNkOm5hbWU6cHdk |
|
GET |
http://test.server.de/odata/WebuserRegister |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Edm.String”, “value”: true } |
4. Funktion WebuserSetPassword
Diese Funktion dient dem Ändern des Passwortes eines Webusers.
|
Parametername |
Parametertyp |
|
Password |
string |
Aufruf
|
Request |
|
|
GET |
http://test.server.de/odata/WebuserRegister(Password=’def’) |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”, “value”: true } |
5. Funktion WebuserReset
Diese Funktion dient dem Rücksetzen des Registrations-Schlüssels für einen Webuser.
|
Parametername |
Parametertyp |
|
— |
— |
Aufruf
|
Request |
|
|
GET |
http://test.server.de/odata/WebuserReset() |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”, “value”: true } |
6. Funktion Webuser
Die Funktion Webuser liefert den Zugriff auf das aktuelle Personen-Objekt. Es kann in einer URL syntaktisch wie ein Personen-Objekt-Zugriff benutzt werden.
|
Parametername |
Parametertyp |
|
— |
— |
Beispielaufruf
|
Request |
|
|
GET |
http://test.server.de/odata/Webuser()?$select=Name,Ort |
Rückgabe/Response
|
Response (Status=200) |
|
{ “@odata.context”: “http://test.server.de/odata/$metadata#Person/$entity”, “_OID”: “477167524F722B793545453746634932716D50793446”, “Name”: “Bottke”, “Ort”: null } |
Die Bildschirmfotos können in aktuellen Programmversionen visuell abweichen.
Sie haben Fragen oder Anregungen? Schreiben Sie uns gerne an support@rackow-software.de