Zuora

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

Versões suportadas

Este conetor tira partido da versão v1 da API Zuora para permitir o acesso bidirecional ao Zuora.

Antes de começar

Antes de usar o conector do Zuora, 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 Zuora 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. Inquilino: defina esta opção para o seu inquilino do Zuora. Por predefinição, usamos o inquilino "USProduction".
   9. URL: isto só é necessário se tiver um ambiente de cópia de produção nos EUA. Se esta propriedade for fornecida, o valor da propriedade Tenant não tem efeito no processo de autenticação.
   10. ZuoraService: especifica o serviço de execução ou o esquema a usar
   11. Use Client Side Paging: indica se o CData ADO.NET Provider for SAP Cloud for Customer deve usar a paginação do lado do cliente.
   12. Usar serviço personalizado: indica se deve ser usado o serviço OData do SAP Cloud for Customer personalizado.
   13. Vistas definidas pelo utilizador: um caminho de ficheiro que aponta para o ficheiro de configuração JSON que contém as suas vistas personalizadas.
   14. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   15. 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 Zuora:

      • Credenciais de cliente 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

Para ativar a autenticação de credenciais de cliente OAuth 2.0, siga estes passos:

1. Crie credenciais de cliente no Zuora e obtenha o ID de cliente e o segredo do cliente.
2. Especifique as credenciais em Google Cloud.

Crie credenciais de cliente no Zuora

1. No portal OneID, clique no seu avatar e, de seguida, em Definições.
2. Clique em Gerir clientes OAuth 2.0.
3. Na página Gerir clientes OAuth 2.0, clique em Novo.
4. Na janela Novo cliente OAuth 2.0, especifique os seguintes campos:
   • Nome: introduza um nome para o cliente.
   • Tipo: selecione Credenciais do cliente na lista.
5. Clique em Guardar. Depois de o cliente ser criado com êxito, é apresentada uma janela com o ID de cliente e o segredo do cliente.

   Guarde o ID de cliente e o segredo do cliente para utilização posterior. Para mais informações, consulte o artigo Faça a gestão de clientes OAuth 2.0 .

Especifique as credenciais em Google Cloud

Quando cria a ligação nos Integration Connectors , tem de especificar os seguintes detalhes:

Na secção Autenticação, introduza os seguintes detalhes:

• ID de cliente: o ID de cliente da app que criou.
• Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente da app associada que criou.

Tipo de ligação Web

A tabela seguinte indica os valores de configuração de exemplo para o tipo de ligação Web do Zuora:

Nome do campo	Detalhes
Localização	us-central1
Conetor	Zuora
Versão do conetor	1
Nome da ligação	zuora-con
Conta de serviço	[e-mail]
Inquilino	INQUILINO
Número mínimo de nós	2
Número máximo de nós	4
ID do cliente	CLIENT_ID
Segredo do cliente	CLIENT_SECRET
Versão do secret	1

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: listar todos os registos em Reembolsos

Este exemplo apresenta todos os registos 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, 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: obtenha um registo de nota de débito

Este exemplo obtém um registo cujo 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 45 no campo Valor predefinido.

   Aqui, 45 é um valor de chave principal na entidade Debit_Memo.

Exemplo: criar um pedido

Este exemplo cria um pedido 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, 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:

   {
   "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 tem um valor semelhante ao seguinte:

   {
   "Name": "Test1695971640609"
   }

Exemplo: atualize uma entrada de ofertas

Este exemplo atualiza o registo cujo 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, 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:

   {
   "Description": "New description"
   }

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

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

Exemplo: elimine um formulário

Este exemplo elimina o registo cujo 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, 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
inquilino	ENUM	Falso	Defina este valor para o seu inquilino do Zuora. Por predefinição, usamos o inquilino "USProduction". Os valores suportados são: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox e USCentralSandbox
url	STRING	Falso	Isto só é necessário se tiver um ambiente de cópia de produção nos EUA. Se esta propriedade for fornecida, o valor da propriedade Tenant não tem efeito no processo de autenticação.
zuora_service	ENUM	Falso	Especifica que serviço de execução ou esquema usar. Os valores suportados são: DataQuery, AQuADataExport
use_client_side_paging	BOOLEAN	Falso	Se o CData ADO.NET Provider for SAP Cloud for Customer deve usar a paginação do lado do cliente ou não.
use_custom_service	BOOLEAN	Falso	Indica se o serviço OData do SAP Cloud for Customer personalizado deve ser usado.
user_defined_views	STRING	Falso	Um caminho de ficheiro que aponta para o ficheiro de configuração JSON que contém as suas vistas personalizadas.

Use a associação do Zuora 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.