Zendesk

El conector de Zendesk te permite realizar operaciones de inserción, eliminación, actualización y lectura en la base de datos de Zendesk.

Versiones compatibles

Este conector es compatible con las APIs de la versión 2 de Zendesk.

Antes de comenzar

Antes de usar el conector de Zendesk, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

• Si deseas usar tu dirección de correo electrónico y contraseña para acceder a la API de Zendesk, habilita password access en el centro de administración de Zendesk. Para obtener más información, consulta Autenticación básica.

Configurar el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona Zendesk en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. Si quieres usar la conexión para suscripciones a eventos, selecciona Habilitar suscripción a eventos. Selección Esto muestra las siguientes opciones:
      • Habilitar la suscripción a eventos con entidad y acciones: Selecciona esta opción para usar la conexión para la suscripción a eventos y las operaciones del conector (entidades y acciones)
      • Habilitar solo suscripción a eventos: Selecciona esta opción para usar la conexión. solo para la suscripción a eventos. Si seleccionas esta opción, haz clic en Siguiente y, luego, configura la suscripción al evento.
   8. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   9. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
   • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Básico: Autenticación HTTP básica.
     • Resumen: Autenticación de HTTP de resumen.
   • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
   • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
   • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
     • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
     • Siempre: La conexión siempre está habilitada para SSL.
     • Nunca: La conexión no está habilitada para SSL.
     • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
   • En la sección Proxy Server, ingresa los detalles del servidor proxy.
     1. Haz clic en Agregar destino.
     2. Selecciona un Tipo de destino.
        • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

          Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

          • Crea un adjunto de servicio de PSC.
          • Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
   10. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   11. Haga clic en SIGUIENTE.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si quieres establecer una conexión privada con tus sistemas de backend, Selecciona Adjunto de extremo de la lista y, luego, selecciona el adjunto de extremo requerido. de la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y el adjunto de extremos. Después de porque creaste el adjunto de extremo, estará visible en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.

   2. Haga clic en SIGUIENTE.
6. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de Zendesk admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña
      • Token de usuario y de API

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haz clic en SIGUIENTE.
7. Si habilitaste la suscripción al evento, aparecerá la sección Event Subscription Details en la página de creación de conexión. Para comprender Cómo configurar los detalles de la suscripción a eventos, consulta Cómo configurar la suscripción a eventos.
8. Revisa: Revisa tus detalles de conexión y autenticación.
9. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• Nombre de usuario y contraseña
  • Nombre de usuario: El nombre de usuario de Zendesk que se usará para la conexión.
  • Contraseña: El secreto de Secret Manager que contiene la contraseña asociada con el nombre de usuario de Zendesk.
• Usuario y token de API
  • Usuario: La cuenta de usuario de Zendesk que se usa para la autenticación.
  • Token de la API: El token de la API del usuario autenticado.

Configura la suscripción a eventos

Si habilitaste la suscripción al evento, ingresa los siguientes valores en la sección Detalles de suscripción al evento:

1. Selecciona un Tipo de destino.
   • Dirección del host: Ingresa la URL de registro de tu sistema de backend en el campo host.
2. Ingresa los detalles de autenticación.
   1. Nombre de usuario: Ingresa el nombre de usuario.
   2. Contraseña: Selecciona el Secret de Secret Manager que contiene la contraseña asociada con el nombre de usuario.
   3. Versión del secreto: Selecciona la versión del secreto.
3. De forma opcional, selecciona Habilitar el enriquecimiento de datos si quieres obtener información adicional. que se anexará a la respuesta del sistema backend.

   La información adicional es específica de la entidad para la que configuraste el evento. Para obtener más información, consulta Enriquecimiento de datos en notificaciones de eventos.

   Nota: Si configuraste esta conexión solo para la suscripción a eventos, no podrás habilitar esta opción. Para habilitar el enriquecimiento de datos, debes configurar la conexión para la suscripción a eventos y las operaciones del conector (entidades y acciones).
4. Selecciona Habilitar conectividad privada para obtener una conectividad segura entre tu aplicación de backend y tu conexión. Si seleccionas esta opción, debes realizar pasos de configuración adicionales después de crear la conexión. Si deseas obtener más información, consulta Conectividad privada para suscripción a eventos.
5. Ingresa la configuración de mensajes no entregados. Si configuras el buzón de mensajes no entregados, la conexión escribirá los eventos sin procesar en el tema de Pub/Sub especificado. Ingresa los siguientes detalles:
   1. ID del proyecto de mensajes no entregados: Es el ID del proyecto de Google Cloud en el que configuraste el tema de mensajes no entregados de Pub/Sub.
   2. Tema de mensajes no entregados: es el tema de Pub/Sub en el que deseas escribir los detalles del evento sin procesar.
6. Si quieres usar un proxy para conectarte a tu backend (para la suscripción a eventos), ingresa los siguientes detalles:
1. Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Seleccionar cualquiera de los siguientes tipos de autenticación:
   • Siempre: La conexión siempre está habilitada para SSL para la suscripción a eventos.
   • Nunca: La conexión no está habilitada para SSL para la suscripción a eventos.
2. Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
   • Básico: Autenticación HTTP básica.
3. Proxy User: Ingresa el nombre de usuario que se usará para autenticar con el servidor proxy.
4. Proxy Password: selecciona el secreto de Secret Manager correspondiente a la contraseña del usuario.
5. Versión del Secret: Selecciona la versión del Secret.
6. En la sección Proxy Server, ingresa los detalles del servidor proxy.
   1. Haz clic en + Agregar destino y, luego, selecciona el Tipo de destino. como Dirección del host.
   2. Ingrese el nombre de host o la dirección IP del servidor proxy y el número de puerto del servidor proxy.

Sugerencia: Para comprender cómo puedes usar la suscripción a eventos en tus integraciones, consulta Activador de Zendesk.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones operaciones no aparecen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y una parámetro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros como los siguientes: el parámetro nombres y su tipo de datos correspondiente. El esquema (metadatos) para entidades y acciones se recupera a través de la conexión en del entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualiza el esquema de conexión.

Limitaciones del sistema

El conector de Zendesk puede procesar 5 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors ajustará la escala de forma automática y dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin mientras esperas el ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Más se requieren nodos para procesar más transacciones para una conexión. Por el contrario, hay menos nodos se requieren si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página de edición de la conexión.
• Si estás basado en una suscripción comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar dependen de varios factores. Antes de ajustar la cantidad mínima de nodos para mejorar la capacidad de procesamiento, te recomendamos verificar si tus sistemas de backend están configurados de manera óptima para manejar el tráfico requerido.

Acciones

El conector de Zendesk ofrece acciones para administrar tus tickets según el ticket ID Para entender cómo configurar el consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Borra un ticket

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DeleteTicketsPermanently y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
     "Id": "18"
   }

En este ejemplo, se borra el ticket de manera permanente. Si la acción se realiza correctamente, tus respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": "true"
}] 

Nota: La operación DeleteTicketsPermanently de forma permanente borra un registro. Si quieres realizar una eliminación no definitiva, usa la operación de eliminación de entidades.

Ejemplo: combinar tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción MergeTickets y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

   {
     "Id": "25",
     "Id": "26"
   }  

En este ejemplo, se combinan las dos entradas. Si la acción se realiza correctamente, tus respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": null,
  "Message": null
}] 

Ejemplo: Restablecer un ticket

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción RestoreTicket y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

   {
     "id": "20"
   } 

En este ejemplo, se restablece un ticket. Si la acción se realiza correctamente, tus respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": "true"
}] 

Ejemplo: Recuperar un ticket suspendido

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción RecoverSuspendedTicket y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
     "id": "18726501985809"
   } 

En este ejemplo, se recupera el ticket suspendido. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Id": "60921"
}]  

Ejemplos de operaciones de entidades

Ejemplo: enumera todos los tickets

En este ejemplo, se enumeran todos los tickets de la entidad Tickets.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Entradas en la lista Entity.
3. Selecciona la operación LIST y, luego, haz clic en Listo.

Ejemplo: Obtener un boleto

En este ejemplo, se obtiene el ticket cuyo ID es 35 de la entidad Tickets.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación GET y, luego, haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa 35 en el campo Default Value.

   Aquí, 35 es el valor de la clave primaria de la entidad Tickets.

Ejemplo: crea un ticket

En este ejemplo, se crea un ticket en la entidad Tickets.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

   {
       "Subject": "Zendesk_Create_Ticket",
       "Description": "Test",
       "Type": "incident",
       "Priority": "urgent",
       "Status": "open",
       "Recipient": null,
       "HasIncidents": false,
       "DueAt": null,
       "RequesterId": 3.84625885158E11,
       "SubmitterId": 3.84625883418E11,
       "AssigneeId": 3.84625883418E11,
       "OrganizationId": "16665992392721",
       "GroupId": 3.60008282358E11,
       "TicketFormId": 3.60001719218E11,
       "BrandId": 3.60003285058E11
     }
     

   Si la integración se realiza correctamente, el campo connectorOutputPayload de tu tarea de conector tendrá una valor similar al siguiente:

    {
       "Id": 38.0
     } 
     

Ejemplo: Actualizar un ticket

En este ejemplo, se actualiza el ticket cuyo ID es 35 en la entidad Tickets.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Entradas en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

   {
         "Subject": "Zendesk_Ticket_Update",
         "Description": "Updating the ticket",
         "RequesterId": 1.6854335860497E13
       }
       

5. Haz clic en entityId y, luego, ingresa 35 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 35.

   Si la integración se realiza correctamente, el campo connectorOutputPayload de tu tarea de conector tendrá una valor similar al siguiente:

   {
          Id": 35.0
       }
       

Ejemplo: Borra un ticket

En este ejemplo, se borra el ticket cuyo ID es 35 en la entidad Tickets.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Entradas en la lista Entity.
3. Selecciona la operación Delete y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 35 en el campo Valor predeterminado.

Nota: La operación Delete solo borra de forma no definitiva el elemento registro. Si es necesario, puedes recuperar el registro borrado más adelante.

Usar Terraform para crear conexiones

Puedes usar Terraform resource para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se utiliza para autenticarse en el proxy ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user	STRING	Falso	Un nombre de usuario que se usará para autenticarse en el proxy ProxyServer.
proxy_password	SECRET	Falso	Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype	ENUM	Falso	El tipo de SSL que se usará para conectarse al proxy ProxyServer. Los valores admitidos son: AUTO, ALWAYS, NEVER y TUNNEL.

Usa la conexión de Zendesk en una integración

Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Connectors.

• Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
• Para comprender cómo crear y usar la tarea Connectors en la integración de aplicaciones, consulta Tarea Connectors.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información sobre cómo suspender y reanudar una conexión.
• Comprende cómo supervisar el uso de los conectores.
• Aprende a ver los registros del conector.