Zuora

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

Versiones compatibles

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

Antes de empezar

Antes de usar el conector de Zuora, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

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

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

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

      Las regiones admitidas para los conectores son las siguientes:

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Conector: selecciona Zuora en la lista desplegable de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
    3. En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    8. Cliente: asigna tu cliente de Zuora. De forma predeterminada, usamos el tenant "USProduction".
    9. URL: solo es obligatorio si tiene un entorno de copia de producción de EE. UU. Si se proporciona esta propiedad, el valor de la propiedad Tenant no tiene ningún efecto en el proceso de autenticación.
    10. ZuoraService especifica qué servicio de ejecución o esquema se debe usar.
    11. Usar paginación del lado del cliente: indica si el proveedor CData ADO.NET para SAP Cloud for Customer debe usar la paginación del lado del cliente.
    12. Usar servicio personalizado: indica si se debe usar el servicio OData de SAP Cloud for Customer personalizado.
    13. Vistas definidas por el usuario: ruta de archivo que apunta al archivo de configuración JSON que contiene tus vistas personalizadas.
    14. También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
    15. Haz clic en Siguiente.
  5. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

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

      • Credenciales de cliente de OAuth 2.0

      2. Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    2. Haz clic en Siguiente.
  6. Revisar: revisa los detalles de la conexión y la autenticación.
  7. Haz clic en Crear.

Configurar la autenticación

Para habilitar la autenticación con credenciales de cliente de OAuth 2.0, sigue estos pasos:

  1. Crea credenciales de cliente en Zuora y obtén el ID y el secreto de cliente.
  2. Especifica las credenciales en Google Cloud.

Crear credenciales de cliente en Zuora

  1. En el portal de OneID, haz clic en tu avatar y, a continuación, en Configuración.
  2. Haz clic en Gestionar clientes de OAuth 2.0.
  3. En la página Gestionar clientes de OAuth 2.0, haga clic en Nuevo.
  4. En la ventana New OAuth 2.0 Client (Nuevo cliente de OAuth 2.0), especifica los siguientes campos:
    • Nombre: introduce un nombre para el cliente.
    • Tipo: selecciona Credenciales de cliente en la lista.
  5. Haz clic en Guardar. Una vez que se haya creado el cliente, aparecerá una ventana con el ID y el secreto de cliente.

    Guarda el ID de cliente y el secreto de cliente para usarlos más adelante. Para obtener más información, consulta Gestionar clientes de OAuth 2.0 .

Especifica las credenciales en Google Cloud

Cuando crees la conexión en Integration Connectors , debes especificar los siguientes detalles:

En la sección Authentication (Autenticación), introduce los siguientes detalles:

  • ID de cliente: el ID de cliente de la aplicación que has creado.
  • Secreto de cliente: secreto de Secret Manager que contiene el secreto de cliente de la aplicación conectada que has creado.

Tipo de conexión web

En la siguiente tabla se muestran los valores de configuración de ejemplo del tipo de conexión web de Zuora:

Nombre del campo Detalles
Ubicación us-central1
Conector Zuora
Versión del conector 1
Nombre de la conexión zuora-con
Cuenta de servicio account@my-project.iam.gserviceaccount.com
Cliente TENANT
Número mínimo de nodos 2
Número máximo de nodos 4
ID de cliente CLIENT_ID
Secreto de cliente CLIENT_SECRET
Versión de secreto 1

Entidades, operaciones y acciones

Todos los conectores de integración 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 te muestra como entidades, operaciones y acciones.

  • Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

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

  • Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

  • Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Ejemplos de operaciones de entidades

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

Ejemplo: Listar todos los registros de 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, a continuación, haz clic en Hecho.
  4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 45 en el campo Valor predeterminado.

    En este caso, 45 es un valor de clave principal de la entidad Debit_Memo.

Ejemplo: Crear una incidencia

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 en la lista Entity.
  3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 la tarea del conector tendrá un valor similar al siguiente:

    {
"Name": "Test1695971640609"
}

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
"Description": "New description"
}
  5. Haga clic en entityId y, a continuación, introduzca 97 en el campo Valor predeterminado.

    También puede definir filterClause como 97 en lugar de especificar entityId.

Ejemplo: eliminar un formulario

En este ejemplo se elimina 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 78 en el campo Valor predeterminado.

Crear conexiones con Terraform

Puedes usar el recurso de Terraform para crear una conexión.

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

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

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

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

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos