Livros do Zoho

Com o conector do Zoho Books, é possível executar operações SQL no sistema do Zoho Books.

Versões compatíveis

O conector aproveita a API do Zoho Books V3 para permitir o acesso bidirecional aos dados do Zoho Books.

Antes de começar

Antes de usar o conector do Zoho Books, faça o seguinte:

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

1. 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"

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 com suporte com o conector:

      Para acessar 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 Zoho Books 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   7. Servidor de contas: o URL completo do servidor de contas.
   8. Organization Id: o ID associado à organização específica da Zoho Books.
   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.
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 do Zoho Books:

      • Concessão de código de autenticação do OAuth 2.0

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

   2. Clique em Próxima.
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.

• Concessão de código de autenticação do 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.
  • Token de acesso: o Secret Manager que contém o token de acesso OAuth fornecido para o app conectado que você criou.

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.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

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

Ações

Esta seção lista algumas das ações compatíveis com a conexão do Zoho Books. 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 ImportCreditCardStatement

Essa ação permite importar extratos do carrinho de crédito.

Parâmetros de entrada da ação ImportCreditCardStatement

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
AccountId	String	Não	ID da conta do banco/cartão de crédito
TransactionsTransactionDebitOrCredit	String	Não	Indica se a transação é débito ou crédito.
TransactionsTransactionAmount	String	Não	Valor envolvido na transação.
TransactionsTransactionDescription	String	Não	Descrição da transação.
TransactionsTransactionDate	String	Não	Data da transação.

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

Exemplos de ação

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

Exemplo: importar uma fatura de cartão de crédito

Este exemplo importa uma fatura de cartão de crédito.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ImportCreditCardStatement e clique em Concluído.
3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

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

[{
"Status": "Your bank statement has been imported."
}]

Exemplos de operação de entidade

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

Exemplo: listar todas as estimativas

Este exemplo lista todos os registros na entidade Estimates.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Estimates na lista de Entity.
3. Selecione a operação List e clique em Concluído.
4. Como opção, na seção Task Input da tarefa Connectors, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Você também pode especificar várias condições de filtro usando os operadores lógicos.

Exemplo: receber um pedido de venda

Este exemplo mostra o pedido de venda especificado da entidade SalesOrder.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista de Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Task Input da tarefa Connectors, clique em EntityId e insira 1470449000000043003 no campo Valor padrão.

   Aqui, 1470449000000043003 é um valor de chave primária na entidade SalesOrder.

Exemplo: criar uma transação bancária

Neste exemplo, é criado um registro de transação bancária na entidade BankTransactions.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione BankTransactions na lista de Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

   {
   "TransactionId": "1470449000000231005"
   }

Exemplo: atualizar os detalhes de contato do cliente

Este exemplo atualiza o registro do cliente especificado na entidade CustomerContacts.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione CustomerContacts na lista de Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

5. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 1470449000000038005 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:

{
"CustomerContactId": "1470449000000038005"
}

Exemplo: excluir um registro de fatura

Este exemplo exclui o registro da fatura especificado na entidade InvoiceDetails.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione InvoiceDetails na lista de Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 1470449000000184001 no campo Valor padrão.

Observação : se a entidade tiver uma chave primária composta, especifique uma cláusula de filtro.

Usar a conexão do Zoho Books em uma integraçã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.