Xero

Este conector fornece acesso de SQL ao seu back-end do Xero.

Antes de começar

Antes de usar o conector Xero, realize as seguintes tarefas:

No seu projeto do Google Cloud, faça o seguinte:
- Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acesse a página "Conexões"
Clique em + Criar novo para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Veja abaixo as regiões com suporte com o conector:
  Para acessar a lista de todas as regiões com suporte, consulte Locais.
2. Clique em Próxima.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Xero na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
3. No campo Nome da conexão, insira um nome para a instância de conexão
  Os nomes de conexão precisam atender aos seguintes critérios:
  - Os nomes de conexões podem usar letras, números ou hifens.
  - As letras precisam ser minúsculas.
  - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das conexões não podem exceder 63 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
6. Opcionalmente, defina as Configurações do nó de conexão:
  - Número mínimo de nós: digite o número mínimo de nós de conexão.
  - Número máximo de nós: digite o número máximo de nós de conexão.
  Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
7. Schema: a API do Xero que você quer acessar como um esquema do banco de dados.
8. Locatário: define a organização do Xero a que se conectar. Pode ser um nome ou ID de locatário.
9. Nível de verbosidade: o nível de verbosidade da conexão varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes da comunicação (solicitações,respostas e certificados SSL).
10. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
11. Clique em Próxima.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  Os seguintes tipos de autenticação são compatíveis com a conexão Xero:
  - Credenciais do cliente OAuth 2.0
  - Concessão de código de autenticação do OAuth 2.0
2. Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

Credenciais do cliente OAuth 2.0
- ID do cliente: o ID do cliente fornecido pelo conector para o app que você criou.
- Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.

Concessão de código de autenticação do OAuth 2.0
- Token de acesso: o token de acesso usado para autenticar solicitações com conexões baseadas em fluxo de código de autenticação.
- ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
- Chave secreta do cliente: é usada para solicitar tokens de acesso.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.
Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
- List
- Receber
- Criar
- Atualizar
- Excluir
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, essas operações não serão listadas na lista Operations.
Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Usar a conexão do Xero em uma integração

Limitações do sistema

O conector Xero pode processar cinco transações por segundo, por nó, e limita qualquer transação além desse limite. No entanto, o número de transações que o conector do Xero pode processar também depende das restrições impostas pela instância do Xero. Para mais informações, consulte Limites de taxa da API Xero. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós dos conectores de integração será escalonado automaticamente com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. São necessários mais nós para processar mais transações para uma conexão. Por outro lado, menos nós serão necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
Se você é um cliente de assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

Esta seção lista algumas das ações suportadas pelo conector. Para entender como configurar as ações, consulte Exemplos de ação.

Observação:os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta connectorOutputPayload da tarefa Connectors depois que você executar a integração.

Ação "DownloadAttachment"

Esta ação faz o download de um anexo.

Parâmetros de entrada da ação DownloadAttachment

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Nome do arquivo	String	Não	Nome do anexo para download.
Tabela	String	Não	Nome da tabela da qual devemos baixar o anexo.
ObjectId	String	Não	ObjectId do anexo.

Parâmetros de saída da ação DownloadAttachment

Esta ação retorna o status 200 (OK) se o download for bem-sucedido.

Para entender como configurar a ação DownloadAttachment, consulte Exemplos de ação.

Ação "UploadAttachment"

Esta ação permite fazer upload de um anexo.

Parâmetros de entrada da ação "UploadAttachment"

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Nome do arquivo	String	Não	Nome do anexo para upload.
ObjectId	String	Não	ObjectId do anexo.
ContentType	String	Não	Tipo de conteúdo do anexo.
Tabela	String	Não	Nome da tabela em que será feito o upload do anexo.
Conteúdo	String	Não	Conteúdo do anexo

Parâmetros de saída da ação UploadAttachment

Esta ação retorna o status 200 (OK) se o upload do objeto for bem-sucedido.

Para entender como configurar a ação UploadAttachment, consulte Exemplos de ação.

Ação ListAttachment

Essa ação permite listar todos os anexos de uma tabela.

Parâmetros de entrada da ação ListAttachment

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
ObjectId	String	Não	ID do objeto do anexo.
Tabela	String	Não	Nome da tabela da qual os anexos devem ser listados.

Parâmetros de saída da ação ListAttachment

Esta ação retornará o status 200 (OK) se a exclusão for bem-sucedida.

Para entender como configurar a ação ListAttachment, consulte Exemplos de ação.

Ação SendInvoiceMail

Com isso, você pode enviar e-mails para o emissor de cobrança.

Parâmetros de entrada da ação SendInvoiceMail

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
InvoiceId	String	Não	ID da fatura para a qual o correio deve ser enviado.

Parâmetros de saída da ação SendInvoiceMail

Esta ação retorna o status 200 (OK) se a operação de movimentação for bem-sucedida.

Para entender como configurar a ação SendInvoiceMail, consulte Exemplos de ação.

Ação "UploadFile"

Essa ação permite fazer upload de um arquivo.

Parâmetros de entrada da ação "UploadFile"

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Nome	String	Não	Nome do arquivo a ser enviado.
Conteúdo	String	Não	Conteúdo do arquivo a ser enviado.

Parâmetros de saída da ação "UploadFile"

Esta ação retorna o status 200 (OK) se o upload do objeto for bem-sucedido.

Para entender como configurar a ação UploadFile, consulte Exemplos de ação.

Exemplos de ação

Nesta seção, descrevemos como executar algumas das ações nesse conector.

Exemplo: fazer o download de um anexo

Este exemplo faz o download de um anexo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DownloadAttachment e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachment terá um valor semelhante a este:

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

Exemplo: fazer upload de um anexo

Neste exemplo, um anexo é enviado.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação UploadAttachment e clique em Concluído.

Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadAttachment terá um valor semelhante a este:

[{
"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
}]

Exemplo: anexos de lista

Este exemplo lista os anexos da tabela especificada.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação ListAttachment e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ListAttachment terá um valor semelhante a este:

[{
"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"
}]

Exemplo: enviar um e-mail de fatura

Neste exemplo, um e-mail é enviado para a fatura especificada.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SendInvoiceMail e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SendInvoiceMail terá um valor semelhante a este:

[{
"Success": "true"
}]

Exemplo: fazer upload de um arquivo

Este exemplo faz upload de um arquivo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação UploadFile e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Name": "Sample1.txt",
"Content": "This is a sample file"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadFile terá um valor semelhante a este:

[{
"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"
}]

Exemplos de operação de entidade

Esta seção mostra como executar algumas das operações da entidade no conector.

Exemplo: listar todos os registros

Neste exemplo, listamos todos os registros na entidade Accounts.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Accounts na lista de Entity.
Selecione a operação List e clique em Concluído.
Como opção, na seção Task Input da tarefa Connectors, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Por exemplo, City='Bangalore'. Também é possível especificar várias condições de filtro usando os operadores lógicos. Por exemplo, City='Bangalore' and region='asia-south2'.

Exemplo: receber uma fatura

Este exemplo recebe uma fatura com o ID especificado da entidade Invoices.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Invoices na lista de Entity.
Selecione a operação Get e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em EntityId e insira 1|016a64c7-be0b-45a2-acae-13057fdf1566 no campo Valor padrão.
Aqui, 1|016a64c7-be0b-45a2-acae-13057fdf1566 é um valor de chave primária na entidade Invoices.

Exemplo: criar uma fatura

Neste exemplo, uma fatura é criada na entidade Invoices.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Invoices na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}
```
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}
```

Exemplo: atualizar um registro

Este exemplo atualiza um registro na entidade AssetTypes.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione AssetTypes na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"BookDepreciationSetting_DepreciationRate": 10.0
}
```
Clique em entityId e, em seguida, insira f8d43548-25b0-4cc3-8f59-d97106974fe8 no campo Valor padrão.
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}
```

Exemplo: excluir um arquivo

Este exemplo exclui o arquivo com o ID especificado da entidade Files.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Files na lista de Entity.
Selecione a operação Delete e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 421c82f0-38fb-4074-a679-63b04c0d8832 no campo Valor padrão.

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte Tarefa Conectores.
Para entender como criar e usar a tarefa de conectores na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Entenda como visualizar os registros do conector.