Acerca del Genetec ClearID™ API - Genetec ClearID™

Guía del Usuario de Genetec ClearID™

series
Genetec ClearID™
revised_modified
2021-05-20
category_custom
Guías
Guías > Guías del usuario
prodname_custom
ClearID

El Genetec ClearID™ API es una interfaz de programación de aplicaciones que los desarrolladores pueden utilizar para ayudar a los clientes y socios a integrar software adicional o realizar funciones personalizadas.

Genetec ClearID™ es un primer servicio de API y la interfaz web está diseñada sobre esa API REST y, como resultado, se puede tener acceso a la mayoría de las funciones de la interfaz web mediante el uso de los extremos de transferencia de estado representacional (REST, por sus siglas en inglés).
La Genetec ClearID™ API está desarrollada con dos objetivos principales:
Independencia de la plataforma
Cualquier cliente debería poder llamar a la API, sin importar cómo se implemente la API de manera interna. Esto requiere el uso de protocolos estándar y contar con un mecanismo en el que el cliente y el servicio web puedan acordar el formato de los datos que se intercambiarán.
Evolución del servicio
La API web debería poder evolucionar y agregar funcionalidades independientemente de las aplicaciones cliente. A medida que la API evoluciona, las aplicaciones cliente existentes deberían continuar funcionando sin modificaciones.

La Genetec ClearID™ API sigue las mejores prácticas para REST y utiliza las acciones HTTP estándar: OBTENER, PUBLICAR, COLOCAR, REVISAR y BORRAR.

Ejemplos

El uso principal de la API REST es la sincronización de identidades, pero también hay muchos otros escenarios posibles.

Estos son algunos ejemplos de los informes o datos que puede obtener de Genetec ClearID™ mediante el uso de la API REST:
  • Lista de todos los eventos próximos y anteriores de visitas.

    Para cada visita: evento, nombre del evento, fecha y hora previstas de llegada y partida, quién solicitó la visita, lista de invitados, tipo de visita, ubicación de estacionamiento, ubicación de encuentro, sitio visitado, áreas en ese sitio y detalles de la aprobación.

  • Lista de todos los anfitriones de visitantes aprobados.
  • Lista de todos los eventos de visitas próximos y anteriores para un solicitante, anfitrión o sitio específicos.
  • Lista de todos los anfitriones activos o inactivos, información sobre permisos para cada anfitrión, detalles de contacto, cargo, departamento y empresa.

Para obtener más información sobre la automatización de funciones con la API REST, consulte la documentación de Genetec ClearID™ API.