Overview of the ClearID API

ClearID Developer Guide

Content type
Guides > Developer guides
Product line
ClearID
Language
English
Applies to
Genetec ClearID

Genetec ClearID™ is a self-service physical access management solution for Synergis™. Using ClearID, you can take control of access and compliance by using a rule-based approach through a web-based interface.

ClearID APIs follows the best practices for REST (Representational State Transfer) and use the standard HTTP verbs: GET, POST, PUT, PATCH, and DELETE.

The API is developed with two main objectives:

  • Platform independence: Any client should be able to call the API, regardless of how the API is implemented internally. This requires using standard protocols, and having a mechanism whereby the client and the web service can agree on the format of the data to exchange.

  • Service evolution: The web API should be able to evolve and add functionality independently from client applications. As the API evolves, existing client applications should continue to function without modification.

ClearID is an API first service and the Web interface is entirely built on top of that REST API. Therefore, most of the functionalities from the Web interface are accessible via REST endpoints.