StoreFront Web API

Write a new Web UI or integrate StoreFront into your own Web portal

Receiver for Web is a component of Citrix StoreFront providing access to applications and desktops using a Web browser. It comprises a User Interface tier and a StoreFront Services Web Proxy tier. This architecture is illustrated below.

The Web Proxy tier is a bridge between the UI tier and the StoreFront Services (namely the Authentication Service and the Store Service). It provides a simplified API suitable for consumption by a JavaScript/Ajax client running in a Web browser.

The main operations available through this API include:

  • Authenticating users through a variety of methods: explicit forms, domain pass-through, smart card, NetScaler Gateway Single Sign-On and post credentials.
  • Enumerating applications/desktops.
  • Enumerating available HDX sessions.
  • Reconnecting, disconnecting and logging off HDX sessions.
  • Launching applications/desktops.
  • Powering off specific VDI desktops.
  • Retrieving images and icons for applications/desktops.
  • Subscribing to applications.

This API is useful for anyone who wants to write a new Web UI or integrate StoreFront into their own Web portal.

Exchange Forum

Documentation

Note: Citrix account credentials are required to access certain SDK content.  If you do not have a Citrix account, please complete the Developer Registration process.

Watch related videos on the Citrix Developer YouTube channel.

Share your ideas with us

SDK Documentation Feedback

We are working to improve our SDK deliverables to make them easier to use.  Click the link below to take a quick survey and share your feedback with our team. 

Open the survey

Create your Citrix Developer account today
An account gives you access to all of the benefits of the Citrix Developer community.

You built a great solution integrating with Citrix APIs, now continue the next step of your journey with Citrix Ready.