ZohoBooks

O conetor do ZohoBooks permite-lhe realizar operações SQL no sistema ZohoBooks.

Versões suportadas

O conetor tira partido da API V3 do Zoho Books para permitir o acesso bidirecional aos dados do Zoho Books.

Antes de começar

Antes de usar o conector do Zoho Books, conclua as seguintes tarefas:

• No seu projeto do Google Cloud:
  • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
  • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (API Connectors)

    Para saber como ativar serviços, consulte o artigo Ativar serviços.

  Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + Criar novo para abrir a página Criar associação.
3. Na secção Localização, escolha a localização para a ligação.
   1. Região: selecione uma localização na lista pendente.

      As regiões suportadas para conetores incluem:

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

   2. Clicar em Seguinte.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conector: selecione Zoho Books na lista pendente de conectores disponíveis.
   2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
   3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   7. Opcionalmente, configure as definições do nó de associação:
      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   8. Servidor de contas: o URL completo do servidor de contas.
   9. Organization Id: o ID associado à organização específica do Zoho Books.
   10. Nível de detalhe: nível de detalhe para a ligação, varia de 1 a 5. Um nível de detalhe mais elevado regista todos os detalhes de comunicação (pedido,resposta e certificados SSL).
   11. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   12. Clicar em Seguinte.
5. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do Zoho Books:

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

   Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clicar em Seguinte.
6. Rever: reveja os detalhes da ligação e da autenticação.
7. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

• Concessão de código de autorização OAuth 2.0
  • ID de cliente: o ID de cliente fornecido pelo conector para a app que criou.
  • Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente da app associada que criou.
  • Token de acesso: segredo do Secret Manager que contém o token de acesso OAuth fornecido para a app associada que criou.

Configure a autenticação do ZohoBooks

As secções seguintes descrevem como configurar o conector do ZohoBooks.

Configure uma conta do ZohoBooks

Para mais informações sobre a configuração da conta do ZohoBooks, consulte o artigo Criação de conta.

Configure uma conta de programador e crie uma app cliente

Para obter informações sobre a conta de programador do ZohoBooks e a criação de apps de cliente, consulte o artigo Criação de apps de cliente.

Configure a autenticação

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

1. Aceda à página Integration Connectors na Cloud Console.
2. Para ver os detalhes de uma associação específica, clique no nome de uma associação na tabela de associações existentes.
3. Na secção Autenticação, clique em Autorizar associação para iniciar o processo de autorização.
4. Copie o URI de redirecionamento.
5. Aceda à ZohoBooks Developer Console.
6. Na secção URIs de redirecionamento autorizados do cliente da aplicação baseada em serviços, adicione o URI de redirecionamento.
7. Na página Conetores de integração, aceda à página de associação do ZohoBooks a partir da qual copiou o URI de redirecionamento e clique em Autorizar.

É redirecionado para o site do ZohoBooks para autorizar.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a associação do Zoho Books.

Tipo de ligação Web

Nome do campo	Detalhes
Região	us-east4
Conetor	ZohoBooks
Versão do conetor	1
Nome da ligaçã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
Âmbitos	ZohoBooks.fullaccess.all
Segredo do cliente	CLIENT_SECRET
Versão do Secret	1

Use a ligação do ZohoBooks numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

• Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Nota: pode ver as entidades, as operações e as ações de um conector na tarefa Conectores.

• Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
  • Lista
  • Obter
  • Criar
  • Atualizar
  • Eliminar

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

• Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Nota: todas as entidades e ações têm um esquema associado. Por exemplo, um esquema de ação tem os detalhes dos parâmetros, como os nomes dos parâmetros e o respetivo tipo de dados. O esquema (metadados) para entidades e ações é obtido pela ligação em tempo de execução a partir do seu back-end. Se existirem atualizações ao esquema, estas não são refletidas automaticamente nas suas associações existentes. Tem de atualizar o esquema manualmente. Para atualizar o esquema de uma associação, abra a página Detalhes da associação da associação e, de seguida, clique em Atualizar esquema da associação.

Ações

Esta secção apresenta algumas das ações suportadas pela associação do Zoho Books. Para compreender como configurar as ações, consulte os exemplos de ações.

Nota: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta da tarefa ConnectorsconnectorOutputPayload após executar a integração.

Ação ImportCreditCardStatement

Esta ação permite-lhe importar extratos de cartões de crédito.

Introduza os parâmetros da ação ImportCreditCardStatement

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
AccountId	String	Não	ID da conta bancária/do 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 compreender como configurar a ação ImportCreditCardStatement, consulte os exemplos.

Exemplos de ações

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

Exemplo: importe um extrato do cartão de crédito

Este exemplo importa um extrato do cartão de crédito.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ImportCreditCardStatement e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:ImportCreditCardStatementconnectorOutputPayload

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

Exemplos de operações de entidades

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

Exemplo: liste todas as estimativas

Este exemplo apresenta todos os registos na entidade Estimates.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Estimates na lista Entity.
3. Selecione a operação List e, de seguida, clique em Concluído.
4. Opcionalmente, na secção Entrada de tarefas da tarefa Conetores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Também pode especificar várias condições de filtro através dos operadores lógicos.

Exemplo: obtenha uma nota de encomenda

Este exemplo obtém a ordem de vendas especificada da entidade SalesOrder.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação Get e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 1470449000000043003 no campo Valor predefinido.

   Aqui, 1470449000000043003 é um valor de chave principal na entidade SalesOrder.

Exemplo: crie uma transação bancária

Este exemplo cria um registo 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 Entity.
3. Selecione a operação Create e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 tem um valor semelhante ao seguinte:

   {
   "TransactionId": "1470449000000231005"
   }

Exemplo: atualizar detalhes de contacto do cliente

Este exemplo atualiza o registo de cliente especificado na entidade CustomerContacts.

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

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

5. Na secção Entrada da tarefa da tarefa Conectores, clique em entityId e, em seguida, introduza 1470449000000038005 no campo Valor predefinido.

Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

{
"CustomerContactId": "1470449000000038005"
}

Exemplo: elimine um registo de fatura

Este exemplo elimina o registo de fatura especificado na entidade InvoiceDetails.

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

Nota: se a sua entidade tiver uma chave primária composta, pode especificar uma cláusula de filtro.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conetor.