SDK and API

Citrix Common Connection Manager SDK

Common Connection Manager (CCM) SDK provides set of native APIs that enables you to interact and perform basic operations programmatically. This SDK does not require a separate download because it is a part of the Citrix Receiver for Windows installation package.

Note: Some of APIs that are related to launch require the ICA file to initiate the launch process to XenApp or XenDesktop sessions.

The CCM SDK capabilities include:

  • Session launch
    • Allows launching applications and desktops using the generated ICA file.
  • Session disconnect
    • Similar to the disconnect operation using the Connection Center of Receiver. The disconnect can be for all the sessions or to a specific user.
  • Session logoff
    • Similar to the logoff operation using the Connection Center of Receiver. The logoff can be for all the sessions or to a specific user.
  • Session information
    • Provides different methods to get connection-related information of the sessions launched. This includes desktop session, application session and reverse seamless application session

For more information about the SDK documentation, see Programmers guide to Citrix CCM SDK.

Citrix Virtual Channel SDK

The Citrix Virtual Channel software development kit (SDK) supports writing server-side applications and client-side drivers for additional virtual channels using the ICA protocol. The server-side virtual channel applications are on XenApp or XenDesktop servers. This version of the SDK supports writing new virtual channels for Receiver for Windows. If you want to write virtual drivers for other client platforms, contact Citrix Technical support.

The Virtual Channel SDK provides:

  • The Citrix Virtual Driver Application Programming Interface (VDAPI) is used with the virtual channel functions in the Citrix Server API SDK (WFAPI SDK) to create new virtual channels. The virtual channel support provided by VDAPI makes it easy to write your own virtual channels.
  • The Windows Monitoring API, which enhances the visual experience and support for third-party applications integrated with ICA.
  • Working source code for virtual channel sample programs to demonstrate programming techniques.
  • The Virtual Channel SDK requires the WFAPI SDK to write the server side of the virtual channel.

For more information about the SDK documentation, see Citrix Virtual Channel SDK for Citrix Receiver for Windows.

Fast Connect 3 Credential Insertion API

The Fast Connect 3 Credential Insertion API provides an interface that supplies user credentials to the Single Sign-on (SSON) feature.This feature is available from Citrix Receiver for Windows Version 4.2 and later. Using this API, Citrix partners can provide authentication and SSO products that use StoreFront or the Web Interface to log users on to virtual applications or desktops and then disconnect users from those sessions.

For more information about the Fast Connect API documentation, see Fast Connect 3 Credential Insertion API for Citrix Receiver for Windows.