Esta página foi traduzida pela API Cloud Translation.

ZohoBooks

Com o conector do ZohoBooks, é possível realizar operações SQL no sistema do ZohoBooks.

Versões compatíveis

O conector aproveita a API 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 a função IAM roles/connectors.admin ao usuário que está 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.
Acessar 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 compatíveis com o conector:
  Para conferir 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 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 ter mais de 49 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Como opção, 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. Servidor de contas: o URL completo do servidor de contas.
9. ID da organização: o ID associado à organização específica do Zoho Books.
10. Nível de detalhes: varia de 1 a 5. O nível de detalhes mais alto registrará todos os detalhes da 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.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  A conexão do Zoho Books oferece suporte aos seguintes tipos de autenticação:
  - Concessão de código de autenticação OAuth 2.0
2. Clique em Next.
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.

Autorização de código 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 do Secret Manager que contém o token de acesso do OAuth fornecido para o app conectado criado.

Configurar a autenticação do ZohoBooks

As seções a seguir descrevem como configurar o conector do ZohoBooks.

Configurar uma conta do ZohoBooks

Para mais informações sobre como configurar a conta do ZohoBooks, consulte Criação de conta.

Configurar uma conta de desenvolvedor e criar um app cliente

Saiba mais sobre a criação de apps cliente e da conta de desenvolvedor do ZohoBooks em Criação de app cliente.

Configurar a autenticação

Para configurar a autenticação, faça o seguinte:

Acesse a página Conectores de integração no Console do Cloud.
Para conferir os detalhes de uma conexão específica, clique no nome dela na tabela de conexões existentes.
Na seção Autenticação, clique em Autorizar conexão para iniciar o processo de autorização.
Copie o URI de redirecionamento.
Acesse o console para desenvolvedores do ZohoBooks.
Na seção URI de redirecionamento autorizado do cliente do aplicativo baseado em serviço, adicione o URI de redirecionamento.
Na página Integration Connectors, acesse a página de conexão do ZohoBooks de onde você copiou o URI de redirecionamento e clique em Autorizar.

Você será redirecionado ao site da ZohoBooks para autorizar.

Exemplos de configuração de conexão

Esta seção lista os valores de amostra para os vários campos que você configura ao criar a conexão do Zoho Books.

Tipo de conexão da Web

Nome do campo	Detalhes
Região	us-east4
Conector	ZohoBooks
Versão do conector	1
Nome da conexão	zohobooks-google-cloud-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Servidor de contas	https://books.zoho.in
ID da organização	ORGANIZATION_ID
Verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
ID do cliente	CLIENT_ID
Escopos	ZohoBooks.fullaccess.all
Chave secreta do cliente	CLIENT_SECRET
Versão do secret	1

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

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

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

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:
- Lista
- 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, 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, . 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 saber como configurar ações, consulte os 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 após a execução da 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 bancária/cartão de crédito
TransactionsTransactionDebitOrCredit	String	Não	Indica se a transação é de 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

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

Exemplo: importar um extrato de cartão de crédito

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

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

Na seção Entrada da tarefa 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 ImportCreditCardStatement resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplos de operações de entidade

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

Exemplo: listar todas as estimativas

Este exemplo lista todos os registros na entidade Estimates.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Estimates na lista Entity.
Selecione a operação List e clique em Concluído.
Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é 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 recebe o pedido de venda especificado da entidade SalesOrder.

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

Este exemplo cria um registro de transação bancária na entidade BankTransactions.

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

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione CustomerContacts na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Department": "Development",
"ContactId": "1470449000000038003"
}
```
Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e 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 para o seguinte:

{
"CustomerContactId": "1470449000000038005"
}

Exemplo: excluir um registro de fatura

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

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

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.
Saiba como acessar os registros do conector.