Creación de webhooks en Genetec ClearID™ - Genetec ClearID™

Guía del Usuario de Genetec ClearID™

Applies to
Genetec ClearID™
Last updated
2022-12-16
Content type
Guías > Guías del usuario
Language
Español
Product
Genetec ClearID™

Puede crear webhooks en Genetec ClearID™ para integrarlos con API de soluciones de terceros y así poder notificar a las partes interesadas cuando ocurran eventos específicos.

Lo que debe saber

  • Solo un administrador de cuentas puede crear webhooks en Genetec ClearID™.
  • Las organizaciones externas son responsables de desarrollar sus propias API (programas o aplicaciones) de soluciones de terceros que consuman notificaciones de devolución de llamada HTTP de webhooks de Genetec ClearID™.

Procedimiento

  1. Desde la página de Inicio, haga clic en Administración > Webhooks.
  2. Haga clic en Agregar webhook.
    Página de detalles del webhook en Genetec ClearID™ en la que se muestra la sección de detalles del Webhook, la sección de Encabezados adicionales y la sección de Evento.
  3. En la sección General, complete los campos:
    1. (Opcional) Mueva el control deslizante de Activado para habilitar o deshabilitar el webhook.
      NOTA: Cuando el webhook está desactivado, la devolución de llamada HTTP no se produce.
    2. En el campo de Nombre, introduzca un Nombre significativo para poder identificar su webhook con facilidad más tarde.
      Por ejemplo, Identidad actualizada o Webhook de solicitudes de identidad creadas, etc.
    3. En el campo de Descripción, introduzca una Descripción que describa el propósito del webhook.
      Por ejemplo, para qué sirve el webhook y qué API (programa o aplicación) notifica cuando ocurren eventos.
  4. En la sección de sección Detalles del webhook, complete los campos:
    1. Introduzca una URL HTTPS:// válida para su API (programa o aplicación).
      Las direcciones URL pueden incluir puertos y parámetros de consulta de la siguiente manera:
      • Ejemplo 1: https://my-api.com/identityupdatedendpoint
      • Ejemplo 2: https://my-api.com:8080/identity-updated-endpoint?my-query-param=123
      Esta URL se usa para reenviar la notificación del evento de webhook a la API de terceros correspondiente (programa o aplicación).
      NOTA: Su organización es responsable de proporcionar la URL a la que desea que se reenvíen las notificaciones de eventos del webhook.
    2. (Opcional) Introduzca la (Clave de aplicación) Secreta si lo requiere la API de terceros.
      La (Clave de la aplicación) secreta se utiliza para autenticar las comunicaciones entre el webhook de Genetec ClearID™ y la API de terceros de su organización.
  5. (Opcional) En la sección de Encabezados adicionales, complete los campos:
    Se puede agregar encabezados HTTP personalizados adicionales en la solicitud de devolución de llamada HTTP para que puedan ser utilizados por la API de terceros del lado de la integración del usuario.
    NOTA: Si introduce un encabezado no válido o reservado, se muestra el siguiente mensaje: El encabezado de la solicitud HTTP enviada no es válido o se está usando de forma incorrecta.
    Sección de encabezados adicionales de la página de detalles de Webhooks en Genetec ClearID™ con un mensaje de encabezado no válido resaltado.
    1. Introduzca el parámetro del encabezado de Nombre.
      Por ejemplo, si tuviera un evento proveniente de varias fuentes, se podría usar encabezados de solicitud HTTP adicionales para especificar de dónde proviene el evento (Genetec ClearID™ o API externa).
      Sección de encabezados adicionales de la página de detalles del Webhook en Genetec ClearID™ en la que se muestra un ejemplo de encabezado adicional de Nombre y Valor.
    2. Introduzca el parámetro del encabezado de Valor.
    3. (Opcional) Haga clic en Agregar encabezado para agregar encabezados de solicitud HTTP adicionales según sea necesario.
      Por ejemplo, si su API espera o requiere un conjunto específico de encabezados (Host, Origen, Idioma, etc.).
    4. (Opcional) Haga clic en para eliminar los encabezados que ya no sean necesarios.
  6. En la sección de Evento, configure los parámetros que necesite:
    1. Desde la lista de Evento, seleccione un evento que desee que este webhook escuche.
    2. Haga clic en Descargar esquema y siga las indicaciones de su navegador.
      MEJOR PRÁCTICA: Utilice la información del esquema descargado para entender la estructura de datos de los eventos para que puedan recuperarse y procesarse de forma correcta del lado de la integración del usuario.
      El siguiente ejemplo muestra un extracto de un archivo schema-identitycreated.json:
      {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "IdentityDeletedCallbackModel",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "AccountId",
          "IdentityId",
          "DeletedBy",
          "DeletionDateUtc"
        ],
        "properties": {
          "AccountId": {
            "type": "string",
            "description": "The account id for which this identity is member of.",
            "minLength": 1
          },
          "IdentityId": {
            "type": "string",
            "description": "A unique id to identify the identity.",
            "minLength": 1
          },
          "ExternalId": {
            "type": [
              "null",
              "string"
            ],
            "description": "External ID"
          },
          "Ordinal": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Commit ordinal in the storage.",
            "format": "int64"
          },
          "Email": {
            "type": [
              "null",
              "string"
            ],
  7. Haga clic en Guardar.

Resultados

Su webhook ahora está configurado para integrarse con una API de terceros (programa o aplicación) para notificar a las partes interesadas cuando se produzcan eventos específicos.

Después de terminar

Usando el esquema descargado, configure su API de terceros para recibir y procesar las notificaciones del webhook.