The Genetec ClearID™ API is an Application Programming Interface that developers can use to help customers and partners integrate additional software or perform custom functions.
Genetec ClearID™ is an API first service and the Web interface is built on top of that
REST API. As a result most of the functionality from the Web interface is accessible by using
Representational State Transfer (REST) endpoints.
The ClearID 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 platform independence requires using standard protocols, and having a mechanism where 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.
The ClearID API follows the best practices for Representational State Transfer (REST) and uses the standard HTTP actions: GET, POST, PUT, PATCH, and DELETE.
Examples
The primary use for the REST API is synchronizing identities, however many other scenarios are also possible.
Here are some examples of the reports or data that you can obtain from ClearID using the REST API:- List of all upcoming and past visit events.
- List of all approved visitor hosts.
- List of all upcoming and past visit events for a specific requester, host, or site.
- List of all active or inactive hosts, permissions information for each host, contact details, title, department, and company.
For each visit you can also obtain the following:
- Event
- Event name
- Expected arrival and departure date and time
- Visit requester
- List of guests
- Visit type
- Parking location
- Meetup location
- Site visited
- Areas on that site
- Approval details
For more information about automating functions using the ClearID REST API, see the Genetec™ Developer documentation.