Acerca de la API de ClearID

2023-06-26Última actualización

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 servicio de API first y la interfaz Web está construida sobre esa API REST. Por eso, 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 API de ClearID está desarrollada con dos objetivos principales:
Independencia de la plataforma
Cualquier cliente debería poder llamar a la API, independientemente de cómo se implemente la API internamente. Esta independencia de la plataforma 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 evoluciona la API, las aplicaciones cliente existentes deben seguir funcionando sin modificaciones.

La API de ClearID sigue las mejores prácticas de Transferencia de estado representacional (REST, por sus siglas en inglés) 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 son posibles muchos otros escenarios.

Estos son algunos ejemplos de los informes o datos que puede obtener de ClearID mediante el uso de la API REST:
  • Lista de todos los eventos de visitas pasadas y próximas.
  • 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 hosts activos o inactivos, información de permisos para cada host, detalles de contacto, cargo, departamento y empresa.
Por cada visita también puede obtener lo siguiente:
  • Evento
  • Nombre del evento
  • Fecha y hora prevista de llegada y salida
  • Solicitante de visita
  • Lista de invitados
  • Tipo de visita
  • ubicación del estacionamiento
  • Ubicación de encuentro
  • Sitio visitado
  • Áreas en ese sitio
  • Detalles de aprobación

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