Xero

Este conector proporciona acceso SQL a tu backend de Xero.

Antes de comenzar

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

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura 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 Xero 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 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. 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.

    7. Esquema: Es la API de Xero a la que deseas acceder como un esquema de base de datos.
    8. Usuario: Configura la organización de Xero a la que se conectará. Puede ser un nombre o un ID de usuario.
    9. Nivel de verbosidad: El nivel de verbosidad para la conexión varía de 1 a 5. Un nivel de verbosidad más alto registrará todos los detalles de comunicación (solicitud,respuesta y certificados SSL).
    10. De manera opcional, haz clic en + Agregar etiqueta (+ Add label) para agregar una etiqueta a la conexión en forma de par clave-valor.
    11. 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 Xero admite los siguientes tipos de autenticación:

      • Credenciales de cliente de OAuth 2.0
      • Otorgamiento de código de autorización de OAuth 2.0

      2. 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.

  • Credenciales de cliente 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.
  • Otorgamiento de código de autenticación de OAuth 2.0
    • Token de acceso: el token de acceso que se usa para autenticar solicitudes con conexiones basadas en el flujo de código de autenticación.
    • 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.

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.

  • 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:

    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, tales operaciones no compatibles no aparecerán 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. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

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

Limitaciones del sistema

El conector Xero puede procesar 5 transacciones por segundo por nodo y limita cualquier transacción que supere este límite. Sin embargo, la cantidad de transacciones que el conector Xero puede procesar también depende de las restricciones impuestas por la instancia de Xero. Para obtener más información, consulta Límites de frecuencia de la API de Xero. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) a una conexión.

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

Acciones

En esta sección, se enumeran algunas de las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Acción DownloadAttachment

Con esta acción, se descarga un archivo adjunto.

Parámetros de entrada de la acción DownloadAttachment

Nombre del parámetro Tipo de datos Requeridos Descripción
Nombre del archivo String No Nombre del archivo adjunto que se descargará.
Tabla String No Nombre de la tabla desde la que tenemos que descargar el archivo adjunto.
ObjectId String No ObjectId del adjunto.

Parámetros de resultado de la acción DownloadAttachment

Esta acción devuelve el estado 200 (OK) si la descarga es exitosa.

Para comprender cómo configurar la acción DownloadAttachment, consulta Ejemplos de acciones.

Acción UploadAttachment

Esta acción te permite subir un archivo adjunto.

Parámetros de entrada de la acción UploadAttachment

Nombre del parámetro Tipo de datos Requeridos Descripción
Nombre del archivo String No Nombre del archivo adjunto que se subirá.
ObjectId String No ObjectId del adjunto.
ContentType String No Tipo de contenido del archivo adjunto.
Tabla String No Nombre de la tabla en la que se debe subir el archivo adjunto.
Temario String No Contenido del archivo adjunto

Parámetros de resultado de la acción UploadAttachment

Esta acción devuelve el estado 200 (OK) si la carga del objeto es correcta.

Para comprender cómo configurar la acción UploadAttachment, consulta Ejemplos de acciones.

Acción de ListAttachment

Esta acción te permite enumerar todos los archivos adjuntos de una tabla.

Parámetros de entrada de la acción ListAttachment

Nombre del parámetro Tipo de datos Requeridos Descripción
ObjectId String No Es el ID de objeto del adjunto.
Tabla String No Nombre de la tabla desde la que se deben enumerar los archivos adjuntos.

Parámetros de salida de la acción ListAttachment

Esta acción devuelve el estado 200 (OK) si la eliminación se realiza correctamente.

Para comprender cómo configurar la acción ListAttachment, consulta Ejemplos de acciones.

Acción SendInvoiceMail

Esta acción te permite enviar correos electrónicos a un emisor de facturas.

Parámetros de entrada de la acción SendInvoiceMail

Nombre del parámetro Tipo de datos Requeridos Descripción
InvoiceId String No Es el ID de la factura a la que se debe enviar el correo.

Parámetros de salida de la acción SendInvoiceMail

Esta acción devuelve el estado 200 (OK) si la operación de movimiento se realiza correctamente.

Para comprender cómo configurar la acción SendInvoiceMail, consulta Ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadFile

Nombre del parámetro Tipo de datos Requeridos Descripción
Nombre String No Nombre del archivo que se subirá.
Temario String No El contenido del archivo que se subirá

Parámetros de resultado de la acción UploadFile

Esta acción devuelve el estado 200 (OK) si la carga del objeto es correcta.

Para comprender cómo configurar la acción UploadFile, consulta Ejemplos de acciones.

Ejemplos de acciones

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

Ejemplo: descargar un archivo adjunto

En este ejemplo, se descarga un archivo adjunto.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachment y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}

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

    [{
"Success": "True",
"Content": "Test content"
}]

Ejemplo: Subir un archivo adjunto

En este ejemplo, se sube un archivo adjunto.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadAttachment y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

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

    [{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Ejemplo: Enumera archivos adjuntos

En este ejemplo, se enumeran los archivos adjuntos de la tabla especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción ListAttachment y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}

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

    [{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Ejemplo: envía un correo electrónico con la factura

En este ejemplo, se envía un correo electrónico para la factura especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendInvoiceMail y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}

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

    [{
"Success": "true"
}]

Ejemplo: Subir un archivo

En este ejemplo, se sube un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadFile y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Name": "Sample1.txt",
"Content": "This is a sample file"
}

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

    [{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Ejemplos de operaciones de entidades

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

Ejemplo: enumera todos los registros

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Accounts de la lista Entity.
  3. Selecciona la operación List y, luego, haz clic en Listo.
  4. De manera opcional, en la sección Entrada de la tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Por ejemplo, City='Bangalore'. También puedes especificar varias condiciones de filtro con los operadores lógicos. Por ejemplo, City='Bangalore' and region='asia-south2'.

Ejemplo: Obtén una factura

En este ejemplo, se obtiene una factura 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 de la lista Entity.
  3. Selecciona la operación Get y haz clic en Listo.
  4. En la sección Task Input de la tarea Conectores, haz clic en EntityId y, luego, ingresa 1|016a64c7-be0b-45a2-acae-13057fdf1566 en el campo Valor predeterminado.

    Aquí, 1|016a64c7-be0b-45a2-acae-13057fdf1566 es un valor de clave primaria en la entidad Invoices.

Ejemplo: crear 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 de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}

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

    {
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}

Ejemplo: actualiza un registro

En este ejemplo, se actualiza un registro en la entidad AssetTypes.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona AssetTypes de la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. Haz clic en entityId y, luego, ingresa f8d43548-25b0-4cc3-8f59-d97106974fe8 en el campo Default Value.

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

    {
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}

Ejemplo: Borra un archivo

En este ejemplo, se borra el archivo con el ID especificado de la entidad Files.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Files de 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 421c82f0-38fb-4074-a679-63b04c0d8832 en el campo Valor predeterminado.

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
  • 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?