Freshbooks

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

Versiones compatibles

Este conector modela la API de FreshBooks Alpha como objetos de base de datos que se pueden consultar con SQL.

Antes de comenzar

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

• En tu proyecto de Google Cloud, haz lo siguiente:
  • 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.

Para obtener información sobre cómo crear una aplicación y generar el ID de cliente y el secreto del cliente para la autenticación, consulta Introducción a la API de FreshBooks.

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 Freshbooks 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. ID de la cuenta: Es el ID de la cuenta a la que se conectará. Si no se especifica un valor, se usará el primero que se devuelva.
   9. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
   10. 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 Freshbooks 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 autenticación de OAuth 2.0
  • Permisos: Es una lista de permisos deseados separados por comas.
  • ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
  • Secreto de cliente: el secreto del cliente que se usa para solicitar tokens de acceso.

Para autorizar la conexión de FreshBooks, haz lo siguiente:

1. En la página Conexiones,haz clic en la conexión de FreshBooks.
2. En la sección Autenticación, haz clic en Autorizar conexión.
3. Navega a la sección URI de redireccionamiento y cópialo.
4. En la aplicación de FreshBooks, haz clic en URIs de redireccionamiento.
5. Pega el URI de redireccionamiento que copiaste de la conexión de FreshBooks y, luego, haz clic en Guardar configuración.
6. Vuelve a la conexión de FreshBooks y haz clic en Autorizar en la sección de autenticación.

   Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la Página Conexiones.

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
  • Obtener
  • 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. 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 del entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se se reflejan 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.

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 todos los proyectos

En este ejemplo, se enumeran todos los proyectos de la entidad Projects.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Projects de la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. De forma opcional, en la sección Task Input de la tarea Connectors, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro.

Ejemplo: Cómo obtener un registro de una entidad

En este ejemplo, se obtiene un registro cuyo ID es 2009015 de la entidad Expense Categories.

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

   Aquí, 2009015 es un valor de clave primaria en la entidad Expense Categories.

Ejemplo: Crea una factura

En este ejemplo, se crea una factura en 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 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:

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

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

   {
   "Id": "49594.0"
   }

Ejemplo: Cómo actualizar una factura

En este ejemplo, se actualiza la factura cuyo ID es 36741.0 en la entidad Invoices.

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

   {
   "FirstName": "James"
   }

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

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

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

   {
   "Id": "36741.0"
   }

Ejemplo: Borra un registro

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

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

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 creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
account_id	STRING	Verdadero	El ID de la cuenta a la que se conectará. Si no se especifica un valor, se usará el primero que se muestre.

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

Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. 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 Conectores en Application Integration, consulta la Tarea Conectores.

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 sobre cómo suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Obtén información para ver los registros de los conectores.