Zuora

El conector de Zuora te permite conectarte a una instancia de Zuora y acceder a los datos de Zuora como una base de datos tradicional.

Versiones compatibles

Este conector aprovecha la versión v1 de la API de Zuora para habilitar el acceso bidireccional a Zuora.

Antes de comenzar

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

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario que configure 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.

Configura 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.

      Entre las regiones admitidas para los conectores, se incluyen las siguientes:

      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 Zuora 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 49 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. 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.
   8. Usuario: Configura esto como tu usuario de Zuora. De forma predeterminada, usamos el inquilino "USProduction".
   9. URL: Esto es obligatorio solo si tienes un entorno de copia de producción en EE.UU. Si se proporciona esta propiedad, el valor de la propiedad Tenant no tiene efecto en el proceso de autenticación.
   10. ZuoraService: Especifica qué servicio o esquema de ejecución usar.
   11. Usar paginación del cliente: Indica si el proveedor de ADO.NET de CData para SAP Cloud for Customer debe usar o no la paginación del cliente.
   12. Use Custom Service: Indica si se debe usar el servicio personalizado de SAP Cloud para los OData del cliente.
   13. Vistas definidas por el usuario: Una ruta de acceso al archivo que apunta al archivo de configuración JSON que contiene tus vistas personalizadas.
   14. De manera opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
   15. Haz clic en Siguiente.
5. 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 Zuora admite los siguientes tipos de autenticación:

      • Credenciales de cliente de OAuth 2.0

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

   2. Haz clic en Siguiente.
6. Revisa: Revisa tus detalles de conexión y autenticación.
7. Haz clic en Crear.

Configura la autenticación

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

• Credenciales de cliente de OAuth 2.0
  • ID de cliente: el ID de cliente que proporciona el conector para la app que creaste.
  • Secreto de cliente: Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.

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
  • Obtén
  • 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 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.

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

Ejemplo: Muestra una lista de todos los registros en Reembolsos

En este ejemplo, se enumeran todos los registros de la entidad Refunds.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Refunds en la lista Entity.
3. Selecciona la operación List y, luego, haz clic en Listo.
4. De manera opcional, en la sección Entrada de tarea de la tarea Conectores, puedes realizar lo siguiente: filtrar tu conjunto de resultados especificando una cláusula de filtro.

Ejemplo: Obtener un registro de nota de débito

En este ejemplo, se obtiene un registro cuyo ID es 45 de la entidad Debit_Memo.

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

   Aquí, 45 es un valor de clave primaria en la entidad Debit_Memo.

Ejemplo: Crea un ticket

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

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets de 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:

   {
   "Name": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

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

   {
   "Name": "Test1695971640609"
   }

Ejemplo: Actualiza una entrada de acuerdos

En este ejemplo, se actualiza el registro cuyo ID es 97 en la entidad Deals.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Deals 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:

   {
   "Description": "New description"
   }

5. Haz clic en entityId y, luego, ingresa 97 en el campo Default Value.

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

Ejemplo: Borra un formulario

En este ejemplo, se borra el registro cuyo ID es 78 en la entidad Forms.

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

Usa 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.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

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

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
instancia	ENUM	Falso	Establece esta opción en tu usuario de Zuora. De forma predeterminada, usamos el inquilino "USProduction". Los valores admitidos son: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url	STRING	Falso	Esto es necesario solo si tienes un entorno de texto de producción en EE.UU. Si se proporciona esta propiedad, el valor de la propiedad Tenant no tiene efecto en el proceso de autenticación.
zuora_service	ENUM	Falso	Especifica qué servicio de ejecución o esquema se usarán los valores admitidos: DataQuery y AQuADataExport
use_client_side_paging	BOOLEAN	Falso	Indica si el proveedor de CData ADO.NET para SAP Cloud for Customer debe usar la paginación del cliente.
use_custom_service	BOOLEAN	Falso	Indica si se debe usar el servicio personalizado de SAP Cloud para el servicio de OData del cliente.
user_defined_views	STRING	Falso	Es una ruta de acceso al archivo que apunta al archivo de configuración JSON que contiene tus vistas personalizadas.

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

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. 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 Connectors en la integración de Apigee, consulta Tarea Connectors.
• 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 para suspender y reanudar una conexión.
• Obtén información para supervisar el uso de los conectores.
• Aprende a ver los registros del conector.