Xero
Este conector proporciona acceso a SQL a tu backend de Xero.
Antes de comenzar
Antes de usar el conector de 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 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:
- En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.
- Haz clic en + Crear nuevo para abrir la página Crear conexión.
- En la sección Ubicación, elige la ubicación para la conexión.
- 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.
- Haz clic en Siguiente.
- Región: selecciona una ubicación de la lista desplegable.
- En la sección Detalles de la conexión, completa lo siguiente:
- Conector: Selecciona Xero en la lista desplegable de conectores disponibles.
- Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
- 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.
- De manera opcional, ingresa una Descripción para la instancia de conexión.
- De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en
Error
. - Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
- 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.
- Esquema: Es la API de Xero a la que deseas acceder como esquema de base de datos.
- Usuario: Configura la organización Xero a la que te conectarás. Puede ser un nombre o un ID de usuario.
- Nivel de verbosidad: El nivel de verbosidad de la conexión 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).
- De manera opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
- Haz clic en Siguiente.
-
En la sección Autenticación, ingresa los detalles de autenticación.
- Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.
La conexión de Xero admite los siguientes tipos de autenticación:
- Credenciales de cliente de OAuth 2.0
- Otorgamiento de código de autenticación de OAuth 2.0
- Haz clic en Siguiente.
Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.
- Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.
- Revisa: Revisa tus detalles de conexión y autenticación.
- Haz clic en Crear.
Configura la autenticación
Ingresa los detalles según la autenticación que desees usar.
-
Credenciales de cliente 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.
-
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 operaciones no aparecen 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.
Usa la conexión de Xero en una integración
Limitaciones del sistema
El conector de Xero puede procesar 5 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. Sin embargo, la cantidad de transacciones que puede procesar el conector Xero 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) por una conexión.
Para obtener 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
Esta acción descarga un archivo adjunto.
Parámetros de entrada de la acción DownloadAttachment
Nombre del parámetro | Tipo de datos | Obligatorio | Descripción |
---|---|---|---|
Nombre del archivo | String | No | Nombre del archivo adjunto que se descargará. |
Tabla | String | No | Nombre de la tabla de la que tenemos que descargar el archivo adjunto. |
ObjectId | String | No | ObjectId del archivo adjunto. |
Parámetros de salida de la acción DownloadAttachment
Esta acción devuelve el estado 200 (OK) si la descarga se realiza correctamente.
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 | Obligatorio | Descripción |
---|---|---|---|
Nombre del archivo | String | No | Nombre del archivo adjunto que se subirá. |
ObjectId | String | No | ObjectId del adjunto. |
ContentType | String | No | Es el tipo de contenido del archivo adjunto. |
Tabla | String | No | Nombre de la tabla en la que se debe subir el archivo adjunto. |
Contenido | String | No | Contenido del archivo adjunto |
Parámetros de salida de la acción UploadAttachment
Esta acción devuelve el estado 200 (OK) si la carga del objeto se realizó correctamente.
Para comprender cómo configurar la acción UploadAttachment
, consulta Ejemplos de acciones.
Acción ListAttachment
Esta acción te permite obtener una lista de todos los archivos adjuntos de una tabla.
Parámetros de entrada de la acción ListAttachment
Nombre del parámetro | Tipo de datos | Obligatorio | Descripción |
---|---|---|---|
ObjectId | String | No | Es el ID de objeto del adjunto. |
Tabla | String | No | Nombre de la tabla de la que se deben enumerar los 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 | Obligatorio | 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 realizó 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 | Obligatorio | Descripción |
---|---|---|---|
Nombre | String | No | Es el nombre del archivo que se subirá. |
Contenido | String | No | Contenido del archivo que se subirá. |
Parámetros de salida de la acción UploadFile
Esta acción devuelve el estado 200 (OK) si la carga del objeto se realizó correctamente.
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: Descarga un archivo adjunto
En este ejemplo, se descarga un archivo adjunto.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Selecciona la acción
DownloadAttachment
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "Filename": "Xero_Test.txt", "Table": "Contacts", "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41" }
Si la acción tiene éxito, el
Respuesta connectorOutputPayload
de la tarea DownloadAttachment
tendrá un valor similar al siguiente:
[{ "Success": "True", "Content": "Test content" }]
Ejemplo: sube un archivo adjunto
En este ejemplo, se sube un archivo adjunto.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Selecciona la acción
UploadAttachment
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el campoDefault Value
:{ "Filename": "Xero_Test.txt", "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41", "ContentType": "txt", "Table": "Contacts", "Content": "Test content upload attachment" }
Si la acción tiene éxito, el
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 adjuntos de la tabla especificada.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Selecciona la acción
ListAttachment
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41", "Table": "Contacts" }
Si la acción tiene éxito, el
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: Enviar una factura por correo electrónico
En este ejemplo, se envía un correo electrónico para la factura especificada.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Selecciona la acción
SendInvoiceMail
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el campoDefault Value
:{ "InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566" }
Si la acción tiene éxito, el
Respuesta connectorOutputPayload
de la tarea SendInvoiceMail
tendrá un valor similar al siguiente:
[{ "Success": "true" }]
Ejemplo: sube un archivo
En este ejemplo, se sube un archivo.
- En el cuadro de diálogo
Configure connector task
, haz clic enActions
. - Selecciona la acción
UploadFile
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el campoDefault Value
:{ "Name": "Sample1.txt", "Content": "This is a sample file" }
Si la acción tiene éxito, el
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
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
Accounts
en la listaEntity
. - Selecciona la operación
List
y, luego, haz clic en Listo. - De manera opcional, en la sección Entrada de tarea de la tarea Conectores, puedes realizar lo siguiente:
filtrar tu conjunto de resultados especificando una cláusula de filtro.
Por ejemplo,
City='Bangalore'
. Tú también puede especificar varias condiciones de filtro con los operadores lógicos. Por ejemplo,City='Bangalore' and region='asia-south2'
.
Ejemplo: Obtener una factura
En este ejemplo, se obtiene una factura con el ID especificado de la entidad Invoices
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
Invoices
de la listaEntity
. - Selecciona la operación
Get
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa
1|016a64c7-be0b-45a2-acae-13057fdf1566
en el campo Default Value.Aquí,
1|016a64c7-be0b-45a2-acae-13057fdf1566
es un valor de clave primaria en la entidadInvoices
.
Ejemplo: crea una factura
En este ejemplo, se crea una factura en la entidad Invoices
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
Invoices
de la listaEntity
. - Selecciona la operación
Create
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault 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
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
AssetTypes
en la listaEntity
. - Selecciona la operación
Update
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "BookDepreciationSetting_DepreciationRate": 10.0 }
- Haz clic en entityId y, luego, ingresa
f8d43548-25b0-4cc3-8f59-d97106974fe8
en el campo Valor predeterminado.Si la integración se realiza de forma correcta, 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
.
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona
Files
de la listaEntity
. - Selecciona la operación
Delete
y haz clic en Listo. - 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 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 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.
- Aprende a ver los registros del conector.