Definitions
The following parameters are used as part of the User Login process:
- Username (UN)
- Used in HTTP Authentication header for every WS API request. This is provided by the WS API application
- Password (PW)
- Used in HTTP Authentication header for every WS API request. This is provided by the WS API application
- Used in HTTP Authentication header for every WS API request. This is provided by the WS API application
- Portal Access Key (PAK)
- PAK is provided as part of login response by VidyoPortal
- PAK is provided as part of login response by VidyoPortal
- EndpointID (EID)
- A unique identifier representing an Endpoint
- This is provided by the VidyoDesktop
- EntityID
- A unique identifier representing an Entity within the VidyoPortal
- This is provided as part of login response by VidyoPortal
- The EntityID is used follow web services API after login to represent any Entity in the VidyoPortal
The following steps describe the sequence of events in the User Login process:
- SOAP-Request from Application to VidyoPortal
logIn (UN, PW) - SOAP-Response from VidyoPortal to Application
logIn (PAK) - HTTP-Request from Application to VidyoDesktop on 127.0.0.1:63457 with the following parameters
- Redirect URL (URL): The VidyoDesktop provides response using a HTTP redirect. The application provides this Redirect URL and processes the information to retrieve the response parameters.
- VidyoManager (vm) address
- VidyoPortal (portal) service address
- VidyoProxy (proxy) address
- UN (UN): Username
- PAK (PAK): Portal Access Key
e.g. http://127.0.0.1:63457/dummy?url=http://dev20.vidyo.com/linkendpoint.ajax?vm=PVCVG7NXUC5YER8FCXBC1ZD88NK6PQ7VYR2918XAXRQA600VM0001@dev20.vidyo.com:17992;transport=TCP&un=chetan&pak=9YprUdCg8gPKpr5H&proxy=64.71.164.195:443&portal=http://main.vidyo.com/services/&loctag=Default_Location
- HTTP-Redirect from VidyoDesktop to Application
- EID
- VidyoDesktop version
http://127.0.0.1:63457/?retrieve=eid - SOAP-Request from Application to VidyoPortal
- linkEndpoint (UN, PW, EID)
- linkEndpoint (UN, PW, EID)
- SOAP-Response from VidyoPortal to Application
- linkEndpoint (OK)
- linkEndpoint (OK)
- The Entity structure includes EntityID
Tip: For guaranteed successful logged in process please check your endpoint status in web browser http://127.0.0.1:63457/?retrieve=epstatus. This will help to safely conclude if the endpoint change the status (online/busy/offline).
Comments
0 comments
Please sign in to leave a comment.