Zuora

O conector Zuora permite que você se conecte a uma instância do Zuora e acesse os dados do Zuora como um banco de dados tradicional.

Versões compatíveis

Esse conector usa a versão v1 da API Zuora para permitir o acesso bidirecional à Zuora.

Antes de começar

Antes de usar o conector da Zuora, 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:

1. 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"

2. Clique em + Criar novo para abrir a página Criar conexão.
3. 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.
4. Na seção Detalhes da conexão, faça o seguinte:
   1. Conector: selecione Zuora 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   8. Locatário: defina como seu locatário do Zuora. Por padrão, usamos "USProduction" locatário.
   9. URL: é necessário apenas se você tiver um ambiente de cópia de produção dos EUA. Se essa propriedade for fornecida, o valor da propriedade "Tenant" não terá efeito no processo de autenticação.
   10. ZuoraService: especifica qual serviço de execução ou esquema usar.
   11. Usar a paginação do lado do cliente: indica se o provedor CData ADO.NET para SAP Cloud for Customer precisa usar a paginação do lado do cliente.
   12. Use Custom Service: indica se o SAP Cloud personalizado para o serviço OData do cliente precisa ser usado.
   13. Visualizações definidas pelo usuário: um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.
   14. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
   15. Clique em Próxima.
5. 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 Zuora:

      • Credenciais do cliente OAuth 2.0

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em Next.
6. Revisão: revise os detalhes de conexão e autenticação.
7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• Credenciais do cliente 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.

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.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• 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 e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação: todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como: os nomes do parâmetro e tipos de dados correspondentes. O esquema (metadados) de entidades e ações é buscado pela conexão no ambiente de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. atualize manualmente o esquema. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Exemplos de operações de entidade

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

Exemplo: listar todos os registros em Reembolsos

Este exemplo lista todos os registros na entidade Refunds.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Refunds na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro.

Exemplo: extrair um registro de memorando de débito

Este exemplo recebe um registro com o ID 45 da entidade Debit_Memo.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Debit_Memo na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 45 no campo Valor padrão.

   Aqui, 45 é um valor de chave primária na entidade Debit_Memo.

Exemplo: criar um tíquete

Este exemplo cria um tíquete na entidade Ticket.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Tickets na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "Name": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá uma semelhante a:

   {
   "Name": "Test1695971640609"
   }

Exemplo: atualizar uma entrada de transações

Este exemplo atualiza o registro com o ID 97 na entidade Deals.

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

   {
   "Description": "New description"
   }

5. Clique em entityId e insira 97 no campo Valor padrão.

   Como alternativa, em vez de especificar o entityId, você também pode definir o filterClause como 97.

Exemplo: excluir um formulário

Este exemplo exclui o registro com o ID 78 na entidade Forms.

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

Usar o Terraform para criar conexões

É possível usar o Terraform recurso para criar uma nova conexão.

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

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

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

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
locatário	ENUM	Falso	Defina isso para seu locatário da Zuora. Por padrão, usamos o locatário "USProduction". Os valores aceitos são: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url	STRING	Falso	Isso é necessário apenas se você tiver um ambiente de cópia de produção dos EUA. Se essa propriedade for fornecida, o valor da propriedade "Tenant" não terá efeito no processo de autenticação.
zuora_service	ENUM	Falso	Especifica qual serviço ou esquema de execução usar. Os valores aceitos são: DataQuery, AQuADataExport
use_client_side_paging	BOOLEAN	Falso	Se o provedor CData ADO.NET para SAP Cloud for Customer deve ou não usar a paginação do lado do cliente.
use_custom_service	BOOLEAN	Falso	Indica se o serviço SAP Cloud personalizado do OData do cliente precisa ser usado.
user_defined_views	STRING	Falso	Um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.

Usar a conexão da Zuora 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 "Connectors" na integração da Apigee, consulte Tarefa Connectors.
• Para entender como criar e usar a tarefa Conectores no 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.
• Saiba como acessar os registros do conector.