Next Topic

Previous Topic

Book Contents

Authenticate

Dieser Vorgang wird benötigt, um eine VSA-API-Webdienstsitzung beginnen zu können. Die zurückgegebene Sitzungs-ID muss mit jeder in der Sitzung aufgerufenen Methode übertragen werden. Die Sitzungs-ID ist nur gültig, wenn sie von dem gleichen Rechner erhalten wird, auf dem auch die Authentifizierung stattfand.

Ein einzelner Datensatz der folgenden Felder wird zurückgegeben.

Sitzungs-ID

Dezimalwert

Die eindeutige Sitzungs-ID, die einer Benutzerverbindung mit der Ziel-URL zugewiesen wird.

Method

Zeichenfolge

Der Vorgang, der diese Antwort anforderte.

TransactionID

Dezimalwert

Die eindeutige Nachrichten-ID dieser Nachricht.

ErrorMessage

Zeichenfolge

Wenn diese Angabe leer ist, wurde kein Fehler zurückgegeben.

ErrorLocation

Zeichenfolge

Wenn diese Angabe leer ist, wurde kein Fehler zurückgegeben.

Automatische Anmeldung während der Authentifizierung

Wenn Sie sich über die API authentifizieren, werden Sie automatisch beim VSA angemeldet. Falls Sie zum Zeitpunkt der Authentifizierung bereits beim VSA angemeldet sind, werden die beiden Sitzungen synchronisiert.  Das Ergebnis ist in beiden Fällen das gleiche – es werden an beiden Ausgangspunkten gültige Sitzungen eingerichtet.

Der VSA sucht in der Abfragezeichenfolge jeder VSA-Seite nach der 26-stelligen Sitzungs-ID der API. Falls der Anwendungsentwickler also auf eine VSA-Seite umleiten muss, kann er jetzt direkt eine Seite aufrufen, ohne dass der Benutzer gezwungen wird, sich erneut anzumelden. Die Syntax lautet:

URL?apiLogonGuid=12345678901234567890123456

Zum Beispiel:

http://someServer:123/Systemtab/SomePage?apiLogonGuid=12345678901234567890123456&SomeVar=SomeValue

API-Aktivität hält die VSA-Sitzung aufrecht. Da der VSA jedoch nicht davon ausgeht, dass stets Bedarf für eine API-Sitzung besteht, hält VSA-Aktivität nicht umgekehrt eine API-Sitzung aufrecht.

Die API verwendet den gleichen Timeout-Wert wie der VSA, welcher über die Seite System > Anmelderegel des VSA gepflegt wird. Der Standardwert ist 30 Minuten.