About the REST API

Prerequisites: Strong working knowledge of Web technologies, especially REST (Representational State Transfer) services. There is no client-side imposed framework or language requirement except that it must be able to handle REST queries.

This section describes the ActivID Credential Management System (CMS) REST Application Programming Interface (API).

It provides information about:

  • What REST is and what the difference is between this API and the Card and Credential Management (CCM) API

  • The authentication model

  • The provided services

  • How to configure ActivID CMS to allow access to the REST API

This information is intended for software programmers or system developers who are responsible for developing applications or extending ActivID CMS functionality using the REST API.

Developers should read this documentation in conjunction with the detailed REST API Swagger documentation.

Important: If there is any divergence between Swagger and this documentation, then developers should consider the Swagger documentation to be the final authority.
Note: The REST API Swagger documentation is available on the disk at the following location: (CMS_DISK)\SDK\API\REST.

Topics in this section: