Integrating ActivID CMS Functionality into Custom Applications

This section introduces the first of the use cases—support for a custom application to manage and synchronize devices. Use cases are comprised of subsections that briefly describe and define using the following format how some type of ActivID CMS functionality can be integrated into a custom application:

Use Case: Allowing a Custom Application to Manage and Synchronize Devices

Use Case Goal

To transparently integrate ActivID CMS functionality into an application, use the application’s interface rather than the ActivID CMS graphical user interface (GUI) with the Card and Credential Management API (CCM API).

Context

Sometimes, it is necessary to invoke ActivID CMS functionality, but not to call the ActivID CMS functions from the ActivID CMS GUI. Most ActivID CMS functions can be invoked from a custom application rather than from the ActivID CMS GUI.

Objectives

The CCM API makes it possible to unify and centralize management of users, devices, credentials, and proprietary information into one single interface, thereby streamlining issuance processes and minimizing training requirements for issuance and Help Desk personnel.

Solution

Use the Card and Credential Management API (CCM API) to integrate device synchronization and management capabilities into custom built applications. The CCM API is frequently used to:

  • Connect to ActivID CMS and perform most of the management tasks that are otherwise performed through the ActivID CMS GUI.

  • Streamline multiple-step issuance processes by integrating the steps into a custom application that would execute all the issuances one after the other using a single interface.

Examples

The following examples briefly describe Help Desk applications and issuance systems.

  • Help Desk Applications

    • Management and/or Help Desk applications can leverage the CCM API to connect to ActivID CMS and perform most of the management tasks that can be performed through the ActivID CMS GUI. These management tasks can include the following:

  • Creating and/or validating device issuance requests

  • Terminating users

  • Obtaining smart card information

  • Issuance Systems

    • The CCM API can simplify device issuance processes by integrating CCM into a custom application that performs all issuance steps one after the other using a single interface. A single application written using the CCM API would be able to issue (synchronize), recycle, and unlock devices. For example, you might be required to have a device that could perform multiple types of access:

    • Physical access (to a secure building)

    • Logical access

      • Using a PKI login to Windows through the physical building third-party access system

      • Using the ActivID CMS Operator Portal

For More Information

For more information, refer to About the CCM API.