Next Topic

Previous Topic

Book Contents

Authenticate

Vereist om de VSA API Web Service sessie te starten. Het teruggegeven sessie-ID moet worden aangeboden met elke methode die tijdens de sessie wordt aangeroepen. Het sessie-ID is alleen geldig als het is ontvangen van dezelfde computer waarvan de verificatie afkomstig is.

Een enkel record wordt teruggeven van de volgende velden.

SessionID

decimal

Het unieke sessie-ID toegewezen aan de verbinding van een gebruiker met de doel-URL.

Method

string

De handeling die dit antwoord heeft aangevraagd.

TransactionID

decimal

Het unieke bericht-ID voor dit bericht.

ErrorMessage

string

Als dit leeg is, is geen fout teruggegeven.

ErrorLocation

string

Als dit leeg is, is geen fout teruggegeven.

Automatische aanmelding tijdens verificatie

Als u via de API verifieert, wordt u automatisch ook bij VSA aangemeld. Als u tijdens de verificatie al bij VSA bent aangemeld, worden de twee sessies gesynchroniseerd.  Het resultaat is in beide gevallen hetzelfde: u krijgt in beide omgevingen een geldige sessie.

De VSA zoekt naar het 26-cijferige sessie-ID van de API in de zoekstring van elke VSA-pagina. Als de ontwikkelaar van de toepassing dus een omleiding nodig heeft naar een VSA-pagina, kan hij nu rechtsreeks naar een pagina gaan zonder de gebruiker te dwingen zich opnieuw aan te melden. De syntaxis is:

URL?apiLogonGuid=12345678901234567890123456

Bijvoorbeeld:

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

Activiteit van de API houdt de VSA-sessie levend. Maar omdat VSA er niet van uitgaat dat er altijd behoefte is aan een API-sessie, houdt VSA-activiteit de API-sessie niet levend.

De API gebruikt dezelfde timeout-waarde alsde VSA, die wordt bijgehouden met de pagina Systeem > Aanmeldingsbeleid van de VSA en waarvan de standaardwaarde 30 minuten is.