API Basics
Note: To use the RAS Web Client, the Enable User Portal option must be enabled for the RAS Secure Gateway in the Parallels RAS Console and the gateway must be reachable on https://<server>/userportal/ where <server> is the IP address or FQDN of the RAS Secure Gateway server.
Parallels Web Client is a browser-based app launcher that is available out of the box with Parallels RAS. The Parallels Web Client is described in detail in the Parallels RAS Administrator's Guide, which is available for download on the Parallels website at the following location: https://www.parallels.com/products/ras/resources/.
The interface described here makes it possible to implement a custom resource launcher.
The following is a typical scenario of the RAS Web Client usage:
A user logs in to the local web portal where the available published resources are listed.
The user clicks on a resource (e.g. an application) that is to be served via Web Client.
A new tab is opened in the web browser in the background using the RAS Web Client URL and some additional parameters, one of which is the name of a JSON payload containing user credentials and the information about the resource being launched. The customer or partner is expected to generate the required payload (we'll talk more about it later in this section).
The Secure Gateway loads the Parallels Web Client and performs a GET request to obtain the JSON payload (see above).
The RAS Web Client then calls a function passing the credentials and resource information.
The user is authenticated and, if successful, the resource is launched on the user's desktop.