Xero

Esse conector oferece acesso SQL ao seu back-end do Xero.

Antes de começar

Antes de usar o conector Xero, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar 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.

Configuração da Xero

As seguintes tarefas são necessárias para configurar o Xero:

Configurar uma conta e uma empresa de demonstração do Xero

  1. Acesse a conta da Xero (em inglês) para criar uma conta gratuita.
  2. Acesse a empresa de demonstração da Xero (em inglês) para ativá-la.

Gerar detalhes de autenticação do cliente OAuth2.0

  1. Faça login na conta de desenvolvedor da Xero.
  2. Clique em Inscrever-se e siga as instruções. Se você já tem uma conta, faça login com suas credenciais.

    3. Você vai ser direcionado ao painel do desenvolvedor da Xero depois de fazer login.

  3. Acesse o portal do desenvolvedor Xero na seção Meus apps no Painel do desenvolvedor.
  4. Clique em Novo aplicativo ou em Criar um novo aplicativo para criar um novo aplicativo.
  5. Insira os detalhes necessários para o app, como o nome, a descrição, o URL da empresa, o URL da Política de Privacidade, o URL dos Termos de Uso e o URL de callback.
  6. Selecione o tipo de app e as permissões necessárias para sua integração com a empresa de demonstração da Xero.

    7. Depois de criar o aplicativo, você receberá as credenciais do OAuth, incluindo um ID e uma chave secreta do cliente.

  7. Armazene o ID e a chave secreta do cliente em um local seguro para uso futuro.

    8. Ao criar a integração, selecione cuidadosamente os escopos necessários para cada esquema a fim de garantir que seu aplicativo tenha as permissões apropriadas para acessar e utilizar os utilitários necessários.

    Para informações sobre autenticação e recuperação do ID e da chave secreta do cliente, consulte Recuperar o ID do cliente e a chave secreta do cliente.

Configurar detalhes do esquema

É possível selecionar o esquema com base no módulo. Os esquemas disponíveis são ACCOUNTING, ASSETS, PAYROLLAUS, ARQUIVOS e PROJETOS. Como temos cinco módulos diferentes, você precisa criar conexões diferentes para cada um deles.

Para saber quais escopos você pode especificar ao criar uma conexão, consulte Escopo.

Configurar detalhes da autorização

Para informações sobre como configurar o URL de autorização, consulte Configurar o URL de autorização.

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:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Veja abaixo as regiões compatíveis com o conector:

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. 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 ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Se quiser, ative o Cloud Logging. e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. 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.

    8. Esquema: a API Xero que você quer acessar como um esquema de banco de dados.
    9. Locatário: define a organização Xero a ser conectada. Pode ser um nome ou ID do locatário.
    10. Nível de detalhes: varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes de comunicação (solicitação, resposta e certificados SSL).
    11. Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    12. Clique em Próxima.
  5. 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 OAuth 2.0

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em Next.
  6. Revisão: revise os detalhes de conexão e autenticação.
  7. 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 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 usado para solicitar tokens de acesso.
    • Chave secreta do cliente: usada para solicitar tokens de acesso.

Configuração da conexão

Esta seção lista os exemplos de valores para os vários campos configurados ao criar a conexão Xero.

Tipo de conexão do servidor de contabilidade

Nome do campo Detalhes
Região us-central1
Conector Xero
Versão do conector 1
Nome da conexão google-cloud-xero-accounting-connection
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Esquema CONTABILIDADE
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos offline_access perfil openid email accounting.transactions, accounting.reports.read, accounting.attachs, accounting.journals.read, accounting.settings, accounting.contacts, accounting.budgets.read
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.xero.com/{identity}/connect/authorize

Tipo de conexão do servidor de recursos

Nome do campo Detalhes
Região us-central1
Conector Xero
Versão do conector 1
Nome da conexão google-cloud-xero-assets-connection
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Esquema RECURSOS
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos assets.read, assets
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.xero.com/{identity}/connect/authorize

Tipo de conexão do servidor de arquivos

Nome do campo Detalhes
Região us-central1
Conector Xero
Versão do conector 1
Nome da conexão google-cloud-xero-files-connection
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Esquema ARQUIVOS
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos files, files.read
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.xero.com/{identity}/connect/authorize

Tipo de conexão do servidor da Payrollaus

Nome do campo Detalhes
Região us-central1
Conector Xero
Versão do conector 1
Nome da conexão google-cloud-xero-payroll-connection
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Esquema PAYROLLAUS
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos payroll.employees, payroll.payruns, payroll.payslip, payroll.timesheets, payroll.settings
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.xero.com/{identity}/connect/authorize

Tipo de conexão do servidor de projetos

Nome do campo Detalhes
Região us-central1
Conector Xero
Versão do conector 1
Nome da conexão google-cloud-xero-projects-connection
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Esquema PROJETOS
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos projetos, projects.read
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.xero.com/{identity}/connect/authorize

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:

    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, como as operações não estã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. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. 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 Xero pode processar também depende as restrições impostas pela instância do Xero. Para mais informações, consulte Limites de taxa da API Xero Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Ações

Esta seção lista algumas das ações aceitas pelo conector. Para saber como configurar ações, consulte os Exemplos de açã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 a ser baixado.
Tabela String Não Nome da tabela de onde precisamos fazer o download do anexo.
ObjectId String Não ObjectId do anexo.

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

Essa 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

Essa ação permite fazer o 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 o anexo será enviado.
Conteúdo String Não Conteúdo do anexo

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

Essa 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 de 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 em que os anexos precisam ser listados.

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

Essa ação retorna 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 SendFaturaMail

Essa ação permite enviar e-mails para um emissor de faturas.

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 e-mail deve ser enviado.

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

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

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

Ação UploadFile

Essa ação permite que você faça 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

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: fazer o download de um anexo

Este exemplo faz o download de um anexo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadAttachment e clique em Concluído.
  3. Na seção Entrada da tarefa 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"
}

    4. Se a ação for bem-sucedida, o DownloadAttachment resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: fazer upload de um anexo

Este exemplo faz upload de um anexo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadAttachment e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

    4. Se a ação for bem-sucedida, o UploadAttachment resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"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.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ListAttachment e clique em Concluído.
  3. Na seção Entrada da tarefa 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"
}

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

Este exemplo envia um e-mail para a fatura especificada.

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

    4. Se a ação for bem-sucedida, o SendInvoiceMail resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"Success": "true"
}]

Exemplo: fazer upload de um arquivo

Neste exemplo, fazemos upload de um arquivo.

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

    4. Se a ação for bem-sucedida, o UploadFile resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"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ções de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os registros

Este exemplo lista todos os registros na entidade Accounts.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Accounts na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, você também pode 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.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Invoices na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Entrada da tarefa 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

Este exemplo cria uma fatura na entidade Invoices.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Invoices na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo 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.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione AssetTypes na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. Clique em entityId e 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.

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

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa Conectores no 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