ZohoBooks

El conector de ZohoBooks te permite realizar operaciones de SQL en el sistema de ZohoBooks.

Versiones compatibles

El conector aprovecha la API de Zoho Books V3 para habilitar el acceso bidireccional a los datos de Zoho Books.

Antes de comenzar

Antes de usar el conector de Zoho Books, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
  • 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 Zoho Books 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. Servidor de cuentas: Es la URL completa del servidor de cuentas.
   9. ID de la organización: Es el ID asociado con la organización específica de Zoho Books.
   10. Nivel de verbosidad: Es el nivel de verbosidad de la conexión, que varía de 1 a 5. Un nivel de verbosidad más alto registrará todos los detalles de la comunicación (solicitud,respuesta y certificados SSL).
   11. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
   12. 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 Zoho Books admite los siguientes tipos de autenticación:

      • Otorgamiento de código de autenticación 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.

• Otorgamiento de código de autorización 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.
  • Token de acceso: Secret de Secret Manager que contiene el token de acceso de OAuth proporcionado para la app conectada que creaste.

Configura la autenticación de ZohoBooks

En las siguientes secciones, se describe cómo configurar el conector de ZohoBooks.

Configura una cuenta de ZohoBooks

Para obtener más información sobre cómo configurar la cuenta de ZohoBooks, consulta Cómo crear una cuenta.

Configura una cuenta de desarrollador y crea una app cliente

Para obtener información sobre la cuenta de desarrollador de ZohoBooks y la creación de apps cliente, consulta Creación de apps cliente.

Configura la autenticación

Para configurar la autenticación, haz lo siguiente:

1. Ve a la página Conectores de integración en la consola de Cloud.
2. Para ver los detalles de una conexión específica, haz clic en el nombre de una conexión en la tabla de conexiones existentes.
3. En la sección Authentication, haz clic en Authorize connection para iniciar el proceso de autorización.
4. Copia el URI de redireccionamiento.
5. Ve a la Developer Console de ZohoBooks.
6. En la sección URI de redireccionamiento autorizado del cliente de la aplicación basada en servicios, agrega el URI de redireccionamiento.
7. En la página Conectores de integración, ve a la página de conexión de ZohoBooks desde la que copiaste el URI de redireccionamiento y haz clic en Autorizar.

Se te redireccionará al sitio de ZohoBooks para autorizar.

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra de los diversos campos que configuras cuando creas la conexión de Zoho Books.

Tipo de conexión web

Nombre del campo	Detalles
Región	us-east4
Conector	ZohoBooks
Versión del conector	1
Nombre de la conexión	zohobooks-google-cloud-conn
Cuenta de servicio	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Servidor de cuentas	https://books.zoho.in
ID de la organización	ORGANIZATION_ID
Verbosidad	5
Cantidad mínima de nodos	2
Cantidad máxima de nodos	50
ID de cliente	CLIENT_ID
Permisos	ZohoBooks.fullaccess.all
Secreto del cliente	CLIENT_SECRET
Versión del Secret	1

Usa la conexión de ZohoBooks 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 Application Integration, consulta Tarea Connectors.

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, estas operaciones no compatibles no se incluyen 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. Por lo general, 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.

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 nombres de los parámetros y su tipo de datos correspondiente. La conexión recupera el esquema (metadatos) de las entidades y las acciones durante el tiempo 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 Actualizar esquema de conexión.

Acciones

En esta sección, se enumeran algunas de las acciones que admite la conexión de Zoho Books. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Nota: Los resultados de todas las acciones estarán disponibles como una respuesta JSON en el parámetro de respuesta connectorOutputPayload de la tarea Connectors después de ejecutar la integración.

Acción ImportCreditCardStatement

Esta acción te permite importar estados de tarjetas de crédito.

Parámetros de entrada de la acción ImportCreditCardStatement

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
AccountId	String	No	ID de la cuenta bancaria o de la tarjeta de crédito
TransactionsTransactionDebitOrCredit	String	No	Indica si la transacción es de débito o crédito.
TransactionsTransactionAmount	String	No	Es el importe involucrado en la transacción.
TransactionsTransactionDescription	String	No	Descripción de la transacción.
TransactionsTransactionDate	String	No	Fecha de la transacción

Para comprender cómo configurar la acción ImportCreditCardStatement, consulta Ejemplos.

Ejemplos de acciones

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

Ejemplo: Cómo importar un estado de cuenta de tarjeta de crédito

En este ejemplo, se importa un estado de cuenta de tarjeta de crédito.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción ImportCreditCardStatement 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:

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea ImportCreditCardStatement tendrá un valor similar al siguiente:

[{
"Status": "Your bank statement has been imported."
}]

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 todas las estimaciones

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

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Estimates en la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. De forma opcional, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. También puedes especificar varias condiciones de filtro con los operadores lógicos.

Ejemplo: Cómo obtener una orden de venta

En este ejemplo, se obtiene el pedido de venta especificado de la entidad SalesOrder.

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

   Aquí, 1470449000000043003 es un valor de clave primaria en la entidad SalesOrder.

Ejemplo: Crea una transacción bancaria

En este ejemplo, se crea un registro de transacción bancaria en la entidad BankTransactions.

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

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

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

   {
   "TransactionId": "1470449000000231005"
   }

Ejemplo: Actualiza los detalles de contacto del cliente

En este ejemplo, se actualiza el registro de cliente especificado en la entidad CustomerContacts.

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

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

5. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 1470449000000038005 en el campo Default Value.

Si la integración se realiza de forma correcta, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

{
"CustomerContactId": "1470449000000038005"
}

Ejemplo: Cómo borrar un registro de factura

En este ejemplo, se borra el registro de factura especificado en la entidad InvoiceDetails.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona InvoiceDetails 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 1470449000000184001 en el campo Default Value.

Nota: Si tu entidad tiene una clave primaria compuesta, puedes especificar una cláusula de filtro.

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.
• Obtén información para ver los registros de los conectores.