A representational state transfer (REST) API is an architectural style for designing networked applications that allows the application to communicate using standard methods and formats. Genetec Clearance™ uses a Swagger-based REST API that accesses multiple endpoints, including the Secure Token Service, Search Service API, Case Service API, and more.
Clearance is built on a series of microservices. Each microservice exposes a simple REST API.
The API is created using Swagger, and we include interactive API documentation with Swagger UI for each service. This feature allows you to easily experiment and observe how the API functions.
REST API endpoints
Secure Token Service (STS): OpenID Connect and OAuth2 service to authenticate.
Search Service API: Service to find any evidence or cases in the system.
Case Service API: Organize your files by case and manage who can view them.
Document Service API: Upload and Get files managed by Clearance.
Device Service: Manage Body Wearable Camera devices.
Key Store: Retrieve Cryptographic keys to encrypt files before uploading them.
Before calling any of the Clearance REST APIs, the service or user must be authenticated through the Secure Token Service that will return a JWT Bearer token. See Authentication.