Zendesk

O conector do Zendesk permite realizar operações de inserção, exclusão, atualização e leitura no banco de dados do Zendesk.

Versões compatíveis

Esse conector é compatível com a versão 2 das APIs do Zendesk.

Antes de começar

Antes de usar o conector do Zendesk, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver 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.

• Se você quiser usar seu endereço de e-mail e senha para acessar a API Zendesk, ative password access na central de administrador do Zendesk. Para mais informações, consulte Autenticação básica.

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.

      Para acessar 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 Zendesk 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. Para usar a conexão para inscrições de eventos, selecione Ativar inscrição de eventos. Ao fazer isso, as seguintes opções são exibidas:
      • Ativar assinatura de evento com entidade e ações: selecione essa opção para usar a conexão para assinatura de eventos e operações de conector (entidades e ações).
      • Ativar somente inscrição de eventos: selecione esta opção para usar a conexão somente para inscrições de eventos.

      Para essas duas seleções, você precisa configurar os detalhes do evento nas etapas subsequentes.

   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. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

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

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
   10. Clique em PRÓXIMA.
5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
   1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
        Observação : para entender como criar um anexo de endpoint, consulte Anexo de serviço PSC e anexo de endpoint. Depois de ter criado o anexo de endpoint, ele vai aparecer na lista Anexo do endpoint.

      Se você quiser estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e, em seguida, configure as regras de firewall para colocar na lista de permissões apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

   2. Clique em PRÓXIMA.
6. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do Zendesk oferece suporte aos seguintes tipos de autenticação:

      • Nome de usuário e senha

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

   2. Clique em PRÓXIMA.
7. Se você tiver ativado a inscrição de eventos, a seção Detalhes da assinatura do evento vai aparecer na página de criação de conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar a assinatura de eventos.
8. Revisão: revise os detalhes de conexão e autenticação.
9. Clique em Criar.

Configurar a autenticação

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

• Nome de usuário e senha
  • Nome de usuário: o nome de usuário do Zendesk a ser usado para a conexão.
  • Senha: secret do Secret Manager que contém a senha associada ao nome de usuário do Zendesk.

Configurar inscrição no evento

Se você tiver ativado a assinatura do evento, insira os seguintes valores na seção Detalhes da assinatura do evento:

1. Selecione um Tipo de destino.
   • Endereço do host: digite o URL de registro do seu sistema de back-end no campo host.
2. Insira os detalhes de autenticação.
   1. Nome de usuário: digite o nome de usuário.
   2. Senha: selecione o secret do Secret Manager com a senha associada ao nome de usuário.
   3. Versão do secret: selecione a versão do secret.
3. Opcionalmente, selecione Ativar o aprimoramento de dados se quiser que mais informações sejam anexadas à resposta do sistema de back-end.

   As informações adicionais são específicas da entidade para a qual você configurou o evento. Para mais informações, consulte Aprimoramento de dados em notificações de eventos.

   Observação:se você tiver configurado a conexão apenas para eventos, não será possível ativar essa opção. Para ativar o aprimoramento de dados, é preciso configurar a conexão para operações de assinatura de eventos e conector (entidades e ações).
4. Selecione Ativar conectividade particular para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, será necessário executar outras etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinaturas de eventos.
5. Insira a configuração de mensagens inativas. Se você configurar mensagens inativas, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
   1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas do Pub/Sub.
   2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
6. Se você quiser usar um proxy para se conectar ao back-end (para assinatura de eventos), digite os seguintes detalhes:
1. Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Selecione um destes tipos de autenticação:
   • Sempre: a conexão está sempre ativada por SSL para a assinatura de eventos.
   • Nunca: a conexão não está ativada para SSL para a assinatura de eventos.
2. 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 compatíveis:
   • Básico: autenticação HTTP básica.
3. Usuário do proxy: digite o nome de usuário que será usado para a autenticação no servidor proxy.
4. Senha do proxy: selecione o secret do Secret Manager da senha do usuário.
5. Versão do secret: selecione a versão do secret.
6. Na seção Servidor proxy, insira os detalhes do servidor proxy.
   1. Clique em + Adicionar destino e selecione Tipo de destino como Endereço do host.
   2. Digite o nome do host ou o endereço IP do servidor proxy e o número da porta do servidor proxy.

Dica:para entender como você pode usar a assinatura de eventos nas suas integrações, consulte Gatilho do Zendesk.

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:
  • 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 for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de 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 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 dos parâmetros e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão no tempo de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. Será necessário atualizar o esquema manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector do Zendesk pode processar cinco transações por segundo, por nó, e limita todas as transações acima desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente com pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
• Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

O conector do Zendesk oferece ações para gerenciar tíquetes com base no ticket ID. Para entender como configurar as ações, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: excluir um tíquete

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteTicketsPermanently e clique em Concluído.
3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "Id": "18"
   }
   

Esse exemplo exclui o tíquete permanentemente. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa de conector terá um valor semelhante ao seguinte:

[{
  "Success": "true"
}] 

Observação : a operação DeleteTicketsPermanently exclui permanentemente um registro. Se você quiser fazer uma exclusão reversível, use a operação de exclusão de entidade.

Exemplo: mesclar tíquetes

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MergeTickets e clique em Concluído.
3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "Id": "25",
     "Id": "26"
   }  
   

Este exemplo mescla os dois tíquetes. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa de conector terá um valor semelhante ao seguinte:

[{
  "Success": null,
  "Message": null
}] 

Exemplo: restaurar um tíquete

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação RestoreTicket e clique em Concluído.
3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "id": "20"
   } 
   

Neste exemplo, restaura um tíquete. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa de conector terá um valor semelhante ao seguinte:

[{
  "Success": "true"
}] 

Exemplo: recuperar um tíquete suspenso

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação RecoverSuspendedTicket e clique em Concluído.
3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "id": "18726501985809"
   } 
   

Este exemplo recupera o tíquete suspenso. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa de conector terá um valor semelhante ao seguinte:

[{
  "Id": "60921"
}]  

Exemplos de operações de entidade

Exemplo: listar todos os ingressos

Este exemplo lista todos os ingressos na entidade Tickets.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Tíquetes" na lista de Entity.
3. Selecione a operação LIST e clique em Concluído.

Exemplo: comprar um ingresso

Este exemplo recebe o tíquete cujo ID é 35 da entidade Tickets.

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

   Aqui, 35 é o valor da chave primária da entidade Tickets.

Exemplo: criar um tíquete

Este exemplo cria um tíquete na entidade Tickets.

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 da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
       "Subject": "Zendesk_Create_Ticket",
       "Description": "Test",
       "Type": "incident",
       "Priority": "urgent",
       "Status": "open",
       "Recipient": null,
       "HasIncidents": false,
       "DueAt": null,
       "RequesterId": 3.84625885158E11,
       "SubmitterId": 3.84625883418E11,
       "AssigneeId": 3.84625883418E11,
       "OrganizationId": "16665992392721",
       "GroupId": 3.60008282358E11,
       "TicketFormId": 3.60001719218E11,
       "BrandId": 3.60003285058E11
     }
     

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

    {
       "Id": 38.0
     } 
     

Exemplo: atualizar um tíquete

Este exemplo atualiza o tíquete cujo ID é 35 na entidade Tickets.

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

   {
         "Subject": "Zendesk_Ticket_Update",
         "Description": "Updating the ticket",
         "RequesterId": 1.6854335860497E13
       }
       

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

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

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

   {
          Id": 35.0
       }
       

Exemplo: excluir um tíquete

Este exemplo exclui o tíquete cujo ID é 35 na entidade Tickets.

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

Observação : a operação Delete faz apenas uma exclusão reversível do registro. Se necessário, você pode recuperar mais tarde o registro excluído.

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform 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 a criação de conexões, consulte Exemplo de modelo.

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
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Zendesk em uma integração

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar 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 a Tarefa "Conectores".
• 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.