Freshbooks

O conetor do FreshBooks permite-lhe estabelecer ligação a uma instância do FreshBooks e aceder aos dados do FreshBooks como uma base de dados tradicional.

Versões suportadas

Este conetor modela a API FreshBooks Alpha como objetos de base de dados que podem ser consultados com SQL.

Antes de começar

Antes de usar o conector do Freshbooks, 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.
  • 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.

Para obter informações sobre como criar uma aplicação e gerar o ID de cliente e o segredo do cliente para autenticação, consulte o artigo Comece a usar a API FreshBooks.

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. Conetor: selecione Freshbooks na lista pendente de conetores 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. ID da conta: o ID da conta à qual se vai ligar. Se não for especificado um valor, é usado o primeiro valor devolvido.
   9. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   10. 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 associação do Freshbooks:

      • 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
  • Âmbitos: uma lista separada por vírgulas dos âmbitos pretendidos.
  • ID de cliente: o ID de cliente usado para pedir tokens de acesso.
  • Segredo do cliente: o segredo do cliente usado para pedir tokens de acesso.

Para autorizar a ligação do FreshBooks, faça o seguinte:

1. Na página Ligações,clique na ligação do FreshBooks.
2. Na secção Autenticação, clique em Autorizar associação.
3. Navegue para a secção URI de redirecionamento e, em seguida, copie-o.
4. Na aplicação FreshBooks, clique em URIs de redirecionamento.
5. Cole o URI de redirecionamento que copiou da ligação do FreshBooks e, de seguida, clique em Guardar definições.
6. Regresse à ligação do FreshBooks e clique em Autorizar na secção de autenticação.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

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.

Exemplos de operações de entidades

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

Exemplo: apresenta todos os projetos

Este exemplo apresenta todos os projetos na entidade Projects.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Projects na lista Entity.
3. Selecione a operação List e, de seguida, clique em Concluído.
4. Opcionalmente, na secção Entrada da tarefa da tarefa Conetores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro.

Exemplo: obter um registo de uma entidade

Este exemplo obtém um registo cujo ID é 2009015 da entidade Expense Categories.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Expense Categories 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 2009015 no campo Valor predefinido.

   Aqui, 2009015 é um valor de chave principal na entidade Expense Categories.

Exemplo: crie 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, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

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

   {
   "Id": "49594.0"
   }

Exemplo: atualize uma fatura

Este exemplo atualiza a fatura cujo ID é 36741.0 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 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:

   {
   "FirstName": "James"
   }

5. Clique em entityId e, de seguida, introduza 36741.0 no campo Valor predefinido.

   Em alternativa, em vez de especificar o entityId, também pode definir a filterClause como 36741.0.

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

   {
   "Id": "36741.0"
   }

Exemplo: elimine um registo

Este exemplo elimina o registo cujo ID é 78 na entidade Payments.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Payments 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 Conetores, clique em entityId e, de seguida, introduza 78 no campo Valor predefinido.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
account_id	STRING	True	O ID da conta a associar. Se não for especificado um valor, é usado o primeiro valor devolvido.

Use a ligação do Freshbooks 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.

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.