> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-client-integration-guide/ras-web-client-api/api-basics.md).

# API Basics

{% hint style="info" %}
**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.
{% endhint %}

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:

1. A user logs in to the local web portal where the available published resources are listed.
2. The user clicks on a resource (e.g. an application) that is to be served via Web Client.
3. 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).
4. The Secure Gateway loads the Parallels Web Client and performs a GET request to obtain the JSON payload (see above).
5. The RAS Web Client then calls a function passing the credentials and resource information.
6. The user is authenticated and, if successful, the resource is launched on the user's desktop.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-client-integration-guide/ras-web-client-api/api-basics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.