QuickBooks Online

El conector de QuickBooks Online le permite realizar operaciones de inserción, eliminación, actualización y lectura en la base de datos de QuickBooks.

Antes de empezar

Antes de usar el conector de QuickBooks Online, 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. Haz clic en + CREAR NUEVA 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.

      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 QuickBooks 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. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
   6. 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.

   Nota: Solo puedes personalizar los valores de los nodos de conexión si tienes una suscripción de pago por uso.
   7. ID de empresa: proporcione el ID de empresa de la aplicación registrada en el portal para desarrolladores de Intuit.
   8. También puedes introducir un código de país para la edición de QuickBooks Online que se esté usando.
   9. También puedes introducir una versión secundaria, que se usará al enviar solicitudes a la API de QuickBooks Online.
   10. Usar entorno aislado: marca la casilla si usas una cuenta de entorno aislado.
   11. (Opcional) En la sección Configuración avanzada, marca la casilla Usar proxy para configurar un servidor proxy para la conexión y define los siguientes valores:
   • Esquema de autenticación de proxy: selecciona el tipo de autenticación para autenticarte con el servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Básica: autenticación HTTP básica.
     • Digest: autenticación HTTP Digest.
   • Usuario proxy: nombre de usuario que se usará para autenticar el servidor proxy.
   • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
   • Tipo de SSL de proxy: el tipo de SSL que se debe usar al conectarse al servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Automático: es el ajuste predeterminado. Si la URL es una URL HTTPS, se usa la opción Tunnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
     • Siempre: la conexión siempre tiene habilitado SSL.
     • Nunca: la conexión no tiene habilitado el protocolo SSL.
     • Túnel: la conexión se realiza a través de un proxy de tunelización. 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 Servidor proxy, introduce los detalles del servidor proxy.
     1. Haga clic en + Añadir destino.
     2. Selecciona un Tipo de destino.
        • Dirección de host: especifica el nombre de host o la dirección IP del destino.

          Si quieres establecer una conexión privada con tu sistema backend, haz lo siguiente:

          • Crea una vinculación de servicio de PSC.
          • Crea un endpoint attachment y, a continuación, introduce los detalles del endpoint attachment en el campo Host address (Dirección de host).
   12. También puedes hacer clic en + AÑADIR ETIQUETA para añadir una etiqueta a la conexión en forma de par clave-valor.
   13. Haz clic en SIGUIENTE.
5. En la sección Destinations (Destinos), introduce los detalles del host remoto (sistema backend) al que quieras conectarte.
   1. Tipo de destino: selecciona un Tipo de destino.
      • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
      • Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).
        Nota: Para saber cómo crear una vinculación de endpoint, consulta Vinculación de servicio de PSC y Vinculación de endpoint. Una vez que haya creado el adjunto de endpoint, se mostrará en la lista Adjunto de endpoint.

      Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.

      Para introducir más destinos, haga clic en +AÑADIR DESTINO.

   2. Haz clic en SIGUIENTE.
6. En la sección Autenticación, introduce los detalles de autenticación.
   • Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.
   1. ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
   2. Scopes: lista separada por comas de los permisos deseados.
   3. Secreto de cliente: secreto de Secret Manager que contiene el secreto de cliente de la aplicación conectada que has creado.
   4. Versión: selecciona la versión en el menú desplegable y concédela.
   5. Haz clic en Siguiente.
7. Revisar: revisa los detalles de la conexión y la autenticación.
8. Haz clic en Crear.
9. Haz clic en Autorizar.

   Si la autorización se realiza correctamente, el estado de la conexión será Activa en la página Conexiones.

Configurar la autenticación

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

• Nombre de usuario y contraseña
  • Nombre de usuario: nombre de usuario del conector.
  • Contraseña: secreto de Secret Manager que contiene la contraseña asociada al conector.

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.

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

• 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:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  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.

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 obtiene el esquema (metadatos) de las entidades y las acciones en tiempo de ejecución de tu backend. Si se realizan cambios en el esquema, estos no se reflejarán automáticamente en las conexiones que ya tengas. Debes actualizar el esquema manualmente. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión y, a continuación, haz clic en Actualizar esquema de conexión.

Limitaciones del sistema

El conector de QuickBooks Online puede procesar 1 transacción por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

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

Nota: El número de nodos de Integration Connectors se ajustará automáticamente de forma dinámica en función de tu uso. Sin embargo, si quieres reservar capacidad para grandes volúmenes sin esperar al escalado automático, puedes ajustar el valor mínimo de los nodos de una conexión. Se necesitan más nodos para procesar más transacciones de una conexión. Por el contrario, se necesitan menos nodos 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 del nodo en la página de edición de la conexión.
• Si tienes una suscripción, ponte en contacto con el equipo de Asistencia.

El número máximo de transacciones que puede gestionar un nodo depende de varios factores. Por lo tanto, antes de ajustar el número mínimo de nodos para mejorar el rendimiento, le recomendamos que compruebe si sus sistemas backend están configurados de forma óptima para gestionar el tráfico necesario.

Ejemplos de operaciones de entidades

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

Ejemplo: obtener una lista con todas las cuentas

En este ejemplo se muestra la entidad Accountsassociated with the Current application of QB Online.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Accounts 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. Especifique siempre el valor de la cláusula de filtro entre comillas simples ('). Por ejemplo, BillId='25'. También puede especificar varias condiciones de filtro mediante operadores lógicos. Por ejemplo, BillId='25' and Active=false.

Ejemplo: obtener un registro

En este ejemplo se obtiene un registro con el ID especificado de la entidad Bills.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Bills 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 220 en el campo Valor predeterminado.

   En este caso, 220 es un valor de clave principal de la entidad Bills.

Ejemplo: crear un registro

En este ejemplo, se crea un registro en la entidad Vendors.

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

   {
   {
     {
       "Id": "32",
       "SyncToken": "0",
       "MetaData_CreateTime": "2024-04-17 17:13:24.0",
       "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
       "Title": null,
       "GivenName": null,
       "MiddleName": null,
       "FamilyName": null,
       "Suffix": null,
       "DisplayName": "tim Telephone",
       "CompanyName": "tim Telephone",
       "PrintOnCheckName": "tim Telephone",
       "Active": true,
       "PrimaryPhone_FreeFormNumber": "[phone]",
       "AlternatePhone_FreeFormNumber": null,
       "Mobile_FreeFormNumber": null,
       "Fax_FreeFormNumber": null,
       "PrimaryEmailAddr_Address": null,
       "WebAddr_URI": null,
       "BillAddr_Id": "33",
       "BillAddr_Line1": "10 Main St.",
       "BillAddr_Line2": null,
       "BillAddr_Line3": null,
       "BillAddr_Line4": null,
       "BillAddr_Line5": null,
       "BillAddr_City": "Palo Alto",
       "BillAddr_Country": null,
       "BillAddr_CountrySubDivisionCode": "CA",
       "BillAddr_PostalCode": "94303",
       "BillAddr_Lat": "37.445013",
       "BillAddr_Long": "-122.1391443",
       "OtherContactInfo_Type": null,
       "OtherContactInfo_Telephone_FreeFormNumber": null,
       "TaxIdentifier": null,
       "TermRef": "1",
       "TermRef_Name": null,
       "Balance": "0",
       "AcctNum": null,
       "Vendor1099": false,
       "CurrencyRef": "USD",
       "CurrencyRef_Name": "United States Dollar"
     }
   }

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

   {
   { "Id": "64" }
   }

Ejemplo: actualizar un registro

En este ejemplo se actualiza el registro con el ID especificado en la entidad Purchases.

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

   {
   {
   "PrivateNote": "Update"
   }
   }

5. Haga clic en entityId y, a continuación, introduzca 22 en el campo Valor predeterminado.

   En este caso, 22 es un valor de clave principal de la entidad Purchases.

Ejemplo: eliminar un registro

En este ejemplo se elimina el registro con el ID especificado de la entidad Invoices.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Invoices en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. Haga clic en entityId y, a continuación, introduzca 10 en el campo Valor predeterminado.

   En este caso, 10 es un valor de clave principal de la entidad Purchases.

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

   {
   {Success}
   }

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