An introduction to the system Application Programming Interface (API) is and its components.
Summary
The system can be configured using an external Application Programming Interface (API). The API allows programmatic communication between client applications and the system. This interface provides the means to create a custom client application to configure and monitor the state of the system. The API is based on the
Simple Object Access Protocol (SOAP) over HTTP(S). SOAP is a transport protocol for exchanging information in a decentralized, distributed environment and enables you to write the business logic and schema for facilitating business-to-business transactions over the Internet.
Benefits
Some benefits of using the system API are
- The API provides developers with the advantage of controlling the system from a custom application. The API enables the client application to configure and monitor the system.
- The interface allows the developers to easily and quickly develop client applications using a language and platform with which the developer is comfortable.
- The API provides a secure, end-to-end, standards-based framework that integrates into the existing infrastructure.
Supported Platforms and Compilers
The following is the support matrix for the API documentation. The XML API has been verified on the platforms / languages as listed below.
Note: This matrix is not intended to limit the functionality of the system API to the specified platforms and tools. The system API is known to work with other systems not yet verified by Citrix.
| Operating System |
C |
| Red Hat Linux, version 7.0 |
g++, version 2.95.2 or later |
| FreeBSD, version 4.1 |
g++, version 2.95.2 or later |
| Windows 2000 |
Visual C++, version 6.0 or later |
| Operating System |
Perl |
| Red Hat Linux, version 7.0 |
SOAP::Lite, version 0.51 |
| FreeBSD, version 4.1 |
SOAP::Lite, version 0.51 |
| Windows 2000 |
SOAP::Lite, version 0.51 |
| Operating System |
Java |
| Red Hat Linux, version 7.0 |
* JSDK 1.4.2 or later
* Axis 1.3 or later
* Xerces-2.5.0 |
| FreeBSD, version 4.1 |
* JSDK 1.4.2 or later
* Axis 1.3 or later
* Xerces-2.5.0 |
| Windows 2000 |
* JSDK 1.4.2 or later
* Axis 1.3 or later
* Xerces-2.5.0 |
| Operating System |
C# |
| Red Hat Linux, version 7.0 |
NA |
| FreeBSD, version 4.1 |
NA |
| Windows 2000 |
Visual Studio 6.0 / Visual Studio.Net |
More Information
