Livros novos

Com o conector, você pode se conectar a uma instância do FreshBooks e acessar os dados dele como um banco de dados tradicional.

Versões compatíveis

Esse conector modela a API FreshBooks Alpha como objetos de banco de dados que podem ser consultados com o SQL.

Antes de começar

Antes de usar o conector do Freshbooks, faça as seguintes tarefas:

No seu projeto do Google Cloud, faça o seguinte:
- 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.
Acesse 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 com suporte com o conector:
  Para acessar 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 Freshbooks 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.
7. ID da conta: o ID da conta a ser conectada. Se um valor não for especificado, o primeiro retornado será usado.
8. 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.
9. 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.
  Os seguintes tipos de autenticação são compatíveis com a conexão do Freshbooks:
  - Concessão de código de autenticação do OAuth 2.0
2. Clique em Próxima.
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.

Concessão de código de autenticação do OAuth 2.0
- Escopos: uma lista separada por vírgulas dos escopos desejados.
- ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
- Chave secreta do cliente: é usada para solicitar tokens de acesso.

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

Exemplos de operação de entidade

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

Exemplo: listar todos os projetos

Neste exemplo, listamos todos os projetos na entidade Projects.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Projects na lista de Entity.
Selecione a operação List e clique em Concluído.
Como opção, na seção Task Input da tarefa Connectors, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro.

Exemplo: receber um registro de uma entidade

Neste exemplo, recebemos um registro com o ID 2009015 da entidade Expense Categories.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Expense Categories na lista de Entity.
Selecione a operação Get e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em EntityId e insira 2009015 no campo Valor padrão.
Aqui, 2009015 é um valor de chave primária na entidade Expense Categories.

Exemplo: criar uma fatura

Neste exemplo, uma fatura é criada na entidade Invoices.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Invoices na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira 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 terá um valor semelhante a este:
```
{
"Id": "49594.0"
}
```

Exemplo: atualizar uma fatura

Este exemplo atualiza a fatura com o ID 36741.0 na entidade Invoices.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Invoices na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FirstName": "James"
}
```
Clique em entityId e, em seguida, insira 36741.0 no campo Valor padrão.
Como alternativa, em vez de especificar o entityId, você também pode definir o filterLesson como 36741.0.

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

Exemplo: excluir um registro

Este exemplo exclui o registro cujo ID é 78 na entidade Payments.

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

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

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

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
account_id	STRING	Verdadeiro	O ID da conta a ser conectada. Se um valor não for especificado, o primeiro retornado será usado.

Usar a conexão do Freshbooks 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.