ZohoBooks

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

Versiones compatibles

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

Antes de empezar

Antes de usar el conector de Zoho Books, 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 Zoho Books 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. Servidor de cuentas: la URL completa del servidor de cuentas.
    9. ID de organización: el ID asociado a la organización específica de Zoho Books.
    10. Nivel de verbosidad: nivel de verbosidad de la conexión, que varía del 1 al 5. Si el nivel de verbosidad es más alto, se registrarán todos los detalles de la comunicación (solicitud, respuesta y certificados SSL).
    11. También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
    12. 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 Zoho Books admite los siguientes tipos de autenticación:

      • Concesión de código de autorización 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

Introduce los detalles en función de la autenticación que quieras usar.

  • Concesión de código de autorización de OAuth 2.0
    • ID de cliente: el ID de cliente proporcionado por el conector 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.
    • Token de acceso: secreto de Secret Manager que contiene el token de acceso de OAuth proporcionado para la aplicación conectada que has creado.

Configurar la autenticación de Zoho Books

En las siguientes secciones se describe cómo configurar el conector Zoho Books.

Configurar una cuenta de Zoho Books

Para obtener más información sobre cómo configurar la cuenta de Zoho Books, consulta el artículo Creación de cuentas.

Configurar una cuenta de desarrollador y crear una aplicación cliente

Para obtener información sobre la cuenta de desarrollador de Zoho Books y la creación de aplicaciones cliente, consulta Creación de aplicaciones cliente.

Configurar la autenticación

Para configurar la autenticación, haz lo siguiente:

  1. Ve a la página Integration Connectors (Conectores de integración) en la consola de Cloud.
  2. Para ver los detalles de una conexión específica, haga clic en su nombre en la tabla de conexiones.
  3. En la sección Autenticación, haga clic en Autorizar conexión para iniciar el proceso de autorización.
  4. Copia el URI de redirección.
  5. Ve a la consola de desarrolladores de Zoho Books.
  6. En la sección de URIs de redirección autorizadas del cliente de la aplicación basada en servicios, añada el URI de redirección.
  7. En la página Integration Connectors (Conectores de integración), ve a la página de conexión de Zoho Books desde la que has copiado el URI de redirección y haz clic en Authorize (Autorizar).

    8. Se te redirigirá al sitio de Zoho Books para que autorices.

Ejemplos de configuración de conexiones

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear 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 organización ORGANIZATION_ID
Verbosidad 5
Número mínimo de nodos 2
Número máximo de nodos 50
ID de cliente CLIENT_ID
Ámbitos ZohoBooks.fullaccess.all
Secreto de cliente CLIENT_SECRET
Versión de secreto 1

Usar la conexión de Zoho Books 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.

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.

Acciones

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

ImportCreditCardStatement action

Esta acción te permite importar extractos 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 Cadena No ID de la cuenta bancaria o de la tarjeta de crédito
TransactionsTransactionDebitOrCredit Cadena No Indica si la transacción es de débito o de crédito.
TransactionsTransactionAmount Cadena No Importe de la transacción.
TransactionsTransactionDescription Cadena No Descripción de la transacción.
TransactionsTransactionDate Cadena No Fecha de la transacción.

Para saber cómo configurar la acción ImportCreditCardStatement, consulta los ejemplos.

Ejemplos de acciones

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

Ejemplo: importar un extracto de tarjeta de crédito

En este ejemplo se importa un extracto de tarjeta de crédito.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción ImportCreditCardStatement y, a continuación, haga clic en Hecho.
  3. 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: 
    {
  "AccountId": "1470449000000023015",
  "TransactionsTransactionDebitOrCredit": "credit",
  "TransactionsTransactionAmount": "200",
  "TransactionsTransactionDescription": "Transaction done from Google account",
  "TransactionsTransactionDate": "2023-05-05"
}

    4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response 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 entidad en este conector.

Ejemplo: listar 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, 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. También puede especificar varias condiciones de filtro mediante operadores lógicos.

Ejemplo: Obtener un pedido de venta

En este ejemplo se obtiene el pedido de ventas 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, 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 1470449000000043003 en el campo Valor predeterminado.

    En este caso, 1470449000000043003 es un valor de clave principal de la entidad SalesOrder.

Ejemplo: crear 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, 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: 
    {
"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: Actualizar los datos de contacto de un 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, 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: 
    {
"Department": "Development",
"ContactId": "1470449000000038003"
}
  5. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 1470449000000038005 en el campo Valor predeterminado.

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

    {
"CustomerContactId": "1470449000000038005"
}

Ejemplo: eliminar un registro de factura

En este ejemplo se elimina 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, 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 1470449000000184001 en el campo Valor predeterminado.

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