QuickBooks Online

O conetor do QuickBooks Online permite-lhe realizar operações de inserção, eliminação, atualização e leitura na base de dados do QuickBooks.

Antes de começar

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

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

   2. Clique em SEGUINTE.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conetor: selecione QuickBooks 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. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   6. 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.
   7. ID da empresa: indique o ID da empresa da app registada no portal de programadores da Intuit.
   8. Opcionalmente, introduza um código do país para a edição do QuickBooks Online que está a ser usada.
   9. Opcionalmente, introduza uma Versão secundária: a usar quando enviar pedidos para a API QuickBooks Online.
   10. Usar área de testes: clique na caixa de verificação se estiver a usar uma conta da área de testes.
   11. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Os seguintes tipos de autenticação são suportados:
     • Básica: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Utilizador do proxy: um nome de utilizador a ser usado para autenticação com o servidor proxy.
   • Palavra-passe do proxy: o segredo do Secret Manager da palavra-passe do utilizador.
   • Tipo de SSL do proxy: o tipo de SSL a usar quando se liga ao servidor proxy. Os seguintes tipos de autenticação são suportados:
     • Automático: predefinição. Se o URL for um URL HTTPS, é usada a opção Túnel. Se o URL for um URL HTTP, é usada a opção NUNCA.
     • Sempre: a ligação está sempre ativada com SSL.
     • Nunca: a ligação não tem o SSL ativado.
     • Túnel: a ligação é feita através de um proxy de túnel. O servidor proxy abre uma ligação ao anfitrião remoto e o tráfego flui em ambas as direções através do proxy.
   • Na secção Servidor proxy, introduza os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do anfitrião: especifique o nome do anfitrião ou o endereço IP do destino.

          Se quiser estabelecer uma ligação privada ao seu sistema de back-end, faça o seguinte:

          • Crie uma associação de serviço do PSC.
          • Crie uma associação de ponto final e, em seguida, introduza os detalhes da associação de ponto final no campo Endereço do anfitrião.
   12. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   13. Clique em SEGUINTE.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
   1. Tipo de destino: selecione um Tipo de destino.
      • Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
      • Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
        Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.

      Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.

      Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.

   2. Clique em SEGUINTE.
6. Na secção Autenticação, introduza os detalhes de autenticação.
   • Selecione um Tipo de autenticação e introduza os detalhes relevantes.
   1. ID de cliente: o ID de cliente usado para pedir tokens de acesso.
   2. Âmbitos: uma lista separada por vírgulas dos âmbitos pretendidos
   3. Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente da app associada que criou.
   4. Versão: selecione a versão no menu pendente e conceda-lhe acesso.
   5. Clicar em Seguinte.
7. Rever: reveja os detalhes da ligação e da autenticação.
8. Clique em Criar.
9. Clique em Autorizar.

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

Configure a autenticação

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

• Nome de utilizador e palavra-passe
  • Nome de utilizador: nome de utilizador do conetor
  • Palavra-passe: Secret do Secret Manager que contém a palavra-passe associada ao conector.

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.

Limitações do sistema

O conector do QuickBooks Online pode processar 1 transação por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

• Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
• Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Exemplos de operações de entidades

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

Exemplo: listar todas as contas

Este exemplo lista todas as entidades Accountsassociated with the Current application of QB Online.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Accounts 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 Conectores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples ('). Por exemplo, BillId='25'. Também pode especificar várias condições de filtro através dos operadores lógicos. Por exemplo, BillId='25' and Active=false.

Exemplo: obter um registo

Este exemplo obtém um registo com o ID especificado da entidade Bills.

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

   Aqui, 220 é um valor de chave principal na entidade Bills.

Exemplo: crie um registo

Este exemplo cria um registo na entidade Vendors.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Vendors 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:

   {
   {
     {
       "Id": "32",
       "SyncToken": "0",
       "MetaData_CreateTime": "2024-04-17 17:13:24.0",
       "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
       "Title": null,
       "GivenName": null,
       "MiddleName": null,
       "FamilyName": null,
       "Suffix": null,
       "DisplayName": "tim Telephone",
       "CompanyName": "tim Telephone",
       "PrintOnCheckName": "tim Telephone",
       "Active": true,
       "PrimaryPhone_FreeFormNumber": "[phone]",
       "AlternatePhone_FreeFormNumber": null,
       "Mobile_FreeFormNumber": null,
       "Fax_FreeFormNumber": null,
       "PrimaryEmailAddr_Address": null,
       "WebAddr_URI": null,
       "BillAddr_Id": "33",
       "BillAddr_Line1": "10 Main St.",
       "BillAddr_Line2": null,
       "BillAddr_Line3": null,
       "BillAddr_Line4": null,
       "BillAddr_Line5": null,
       "BillAddr_City": "Palo Alto",
       "BillAddr_Country": null,
       "BillAddr_CountrySubDivisionCode": "CA",
       "BillAddr_PostalCode": "94303",
       "BillAddr_Lat": "37.445013",
       "BillAddr_Long": "-122.1391443",
       "OtherContactInfo_Type": null,
       "OtherContactInfo_Telephone_FreeFormNumber": null,
       "TaxIdentifier": null,
       "TermRef": "1",
       "TermRef_Name": null,
       "Balance": "0",
       "AcctNum": null,
       "Vendor1099": false,
       "CurrencyRef": "USD",
       "CurrencyRef_Name": "United States Dollar"
     }
   }

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

   {
   { "Id": "64" }
   }

Exemplo: atualize um registo

Este exemplo atualiza o registo com o ID especificado na entidade Purchases.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Teams 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 Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   {
   "PrivateNote": "Update"
   }
   }

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

   Aqui, 22 é um valor de chave principal na entidade Purchases.

Exemplo: elimine um registo

Este exemplo elimina o registo com o ID especificado 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 Delete e, de seguida, clique em Concluído.
4. Clique em entityId e, de seguida, introduza 10 no campo Valor predefinido.

   Aqui, 10 é um valor de chave principal na entidade Purchases.

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

   {
   {Success}
   }

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