À propos de l’API ClearID - ClearID

Guide de l'utilisateur Genetec ClearID™

Applies to
ClearID
Last updated
2024-03-22
Content type
Guides > Guides de l'utilisateur
Language
Français
Product
ClearID

L’API Genetec ClearID™ est une interface de programmation que les développeurs peuvent utiliser pour aider leurs clients et partenaires à intégrer des logiciels supplémentaires ou des fonctions personnalisées.

Genetec ClearID™ est un service conçu en priorité autour d'une API, et l’interface Web est bâtie sur cette API REST. La majorité des fonctionnalités de l’interface Web sont donc accessibles en utilisant des points de terminaison REST (Representational State Transfer).
L’API ClearID est conçue pour répondre à deux objectifs principaux :
Indépendance de la plateforme
Tout client doit pouvoir appeler l’API, indépendamment de la mise en œuvre interne de l’API. Cette indépendance de la plate-forme exige l’utilisation de protocoles standard, et de disposer d'un mécanisme permettant au client et au service Web de s'entendre sur le format des données à échanger.
Évolution du service
L'API web doit pouvoir évoluer et intégrer de nouvelles fonctionnalités, indépendamment de l’application client. En cas d’évolution de l’API, les applications client doivent continuer à fonctionner sans modification.

L’API ClearID suit les meilleures pratiques REST (Representational State Transfer) et exploite les actions HTTP standard : GET, POST, PUT, PATCH et DELETE.

Exemples

L’API REST sert principalement à synchroniser les identités, mais bien d'autres utilisations sont possibles.

Voici quelques exemples de rapports ou de données que vous pouvez obtenir de ClearID en exploitant l’API REST :
  • La liste de tous les événements de visite à venir et passés.
  • La liste de tous les hôtes de visiteurs approuvés.
  • La liste de tous les événements de visite à venir et passés pour un demandeur, un hôte ou un site particulier.
  • La liste de tous les hôtes actifs ou inactifs, les autorisations de chaque hôte, les coordonnées, la fonction, le service et la société.
Pour chaque visite, vous pouvez obtenir les éléments suivants :
  • Événement
  • Nom de l'événement
  • Dates et heures d'arrivée et de départ prévues
  • Demandeur de visite
  • Liste d'invités
  • Type de visite
  • Emplacement de stationnement
  • Lieu de rendez-vous
  • Site visité
  • Secteurs de ce site
  • Détails de l’approbation

Pour en savoir plus sur l’automatisation des fonctions à l'aide de l’API REST de ClearID, voir la documentation pour Développeurs Genetec™.