Une API de transfert d'état de représentation (REST) est un style architectural pour la conception d'applications en réseau qui permet à l'application de communiquer à l'aide de méthodes et de formats standard. Genetec Clearance™ utilise une API REST basée sur Swagger qui accède à plusieurs terminaux, dont le Secure Token Service, API Search Service, API Case Service, etc.
Clearance repose sur une série de microservices. Chaque microservice expose une API REST simple.
L'API est créée avec Swagger, et nous incluons documentation API interactive avec l'interface utilisateur Swagger pour chaque service. Cette fonctionnalité vous permet d’expérimenter et d’observer facilement le fonctionnement de l’API.
Points de terminaison de l'API REST
Service de jeton sécurisé (STS) : OpenID Connect et service OAuth2 pour l’authentification.
API Search Service : service permettant de trouver des preuves ou des dossiers dans le système.
API Case Service : organisez vos fichiers par dossier et gérez qui peut les consulter.
API Document Service : transférez et récupérez des fichiers gérés par Clearance.
Device Service : gérez les caméras corporelles.
Key Store : récupérez les clés de chiffrement pour chiffrer les fichiers avant de les transférer.
Avant d'appeler l'une des API REST de Clearance, le service ou l'utilisateur doit être authentifié via le service de jeton sécurisé qui renverra un jeton du porteur JWT. Voir Authentification.