API Guide

User Interface Service

Product Info XDOC 5200
Last Update January 10, 2013

General Overview

This document provides the specification for the XDOC User Interface Service API, which can be used by 3rd party applications to launch XDOC user interface web pages. Throughout this document, references to the 3rd party application will be called the Integrated Application.

Integrated Applications need a way to invoke XDOC Viewers and other User Interfaces from within their own applications. Since XDOC is typically deployed as a separate system, securely launching XDOC user interfaces from the Integrated Application requires coordination and minor authentication integration between the 2 systems.

XDOC User Interfaces can be launched in separate browser windows, or embedded in the Integrated Application. Embedding can be accomplished using either HTML IFrames if the Integrated Application is browser based, or Web Browser controls if the Integration Application is Client Server, thick client, or other technology.

The XDOC User Interface Service provides the following features:

  • A single HTTP endpoint URL to use for launching all XDOC user interfaces.
  • Support for encrypted auto-logon authentication credential passing.
  • HTTPS / SSL support for secure transmission.

This document is divided into the following sections:

SECTION DESCRIPTION
S1 Service Invocation Syntax Specification for the URL endpoint and required parameters to invoke the service.
S2 User Interface Link Listing List of the User Interfaces that can be launched using the service.
S3 User Interface Link Details Detailed specification and parameter listing for each User Interface link.
S4 User Token Credential Passing Specification for how to pass User credentials for auto-logon / single sign-on type integration.
S5 Security Token Authentication Additional security mechanisms to prevent unauthorized access.

Additional Notes:

  • The Service provides a default implementation for handling secure trusted and auto-logon user credential passing from the Integrated Application to XDOC. The Customer or the Integrated Application developers can always override the security handling and credential passing if desired.