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:

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.
  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 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 em inscrições em eventos, selecione Ativar inscrição em eventos. Ao selecionar essa opção, aparecem as seguintes opções:
  - Ativar inscrição de eventos com entidade e ações: selecione essa opção para usar a conexão na inscrição de eventos e nas operações do conector (entidades e ações).
  - Ativar somente assinatura de eventos: selecione essa opção para usar a conexão apenas para a assinatura de eventos.
  Para essas duas seleções, você vai precisar configurar os detalhes do evento nas próximas etapas.
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.
8. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
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.
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.
  1. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.
    1. Se você quiser estabelecer uma conexão privada com seus sistemas de back-end, siga estas etapas:
      1. Crie um anexo do serviço PSC.
      2. Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
    2. Para 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 configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
  Para inserir outros destinos, clique em +ADICIONAR DESTINO.
2. 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.
  A conexão do Zendesk oferece suporte aos seguintes tipos de autenticação:
  - Nome de usuário e senha
2. Clique em PRÓXIMA.
Se você tiver ativado a inscrição de eventos, a seção Detalhes da inscrição de eventos aparecerá na página de criação da conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar assinatura de eventos.
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.

Nome de usuário e senha
- Nome de usuário: o nome de usuário do Zendesk a ser usado para a conexão.
- Password: chave secreta do Secret Manager que contém a senha associada ao nome de usuário do Zendesk.

Configurar assinatura de eventos

Se você ativou a inscrição do evento, digite os seguintes valores na seção Detalhes da assinatura do evento:

Selecione um Tipo de destino.
- Endereço do host: insira o URL de registro do sistema de back-end no campo host.
Digite os detalhes de autenticação.
1. Nome de usuário: digite o nome de usuário.
2. Password: selecione o secret do Secret Manager que contém a senha associada ao nome de usuário.
3. Versão do secret: selecione a versão do secret.
Opcionalmente, selecione Ativar o enriquecimento 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 onde você configurou o evento. Para mais informações, consulte Aprimoramento de dados em notificações de eventos.

Observação:se você configurou essa conexão apenas para assinatura de eventos, não será possível ativar essa opção. Para ativar o enriquecimento de dados, configure a conexão para as operações de assinatura de eventos e conector (entidades e ações).
Selecione Ativar conectividade particular para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, precisará executar etapas de configuração adicionais depois de criar a conexão. Para mais informações, consulte Conectividade particular para inscrição em eventos.
Insira a configuração de mensagens inativas. Se você configurar a mensagem inativa, 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 do Pub/Sub de mensagens inativas.
2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer escrever os detalhes do evento não processado.
Se quiser usar um proxy para se conectar ao back-end (para assinatura de eventos), insira os seguintes detalhes:

Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Selecione um dos seguintes tipos de autenticação:
- Sempre: a conexão está sempre com o SSL ativado para a inscrição em eventos.
- Nunca: a conexão não está com SSL ativado para inscrição em eventos.
Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há suporte para os seguintes tipos de autenticação:
- Básico: autenticação HTTP básica.
Proxy User: digite o nome de usuário que será utilizado para autenticar o servidor proxy.
Proxy Password: selecione o secret do Secret Manager da senha do usuário.
Versão do secret: selecione a versão do secret.
Na seção Servidor proxy, insira os detalhes do servidor proxy.
1. Clique em + Adicionar destino e selecione o 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.

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.

Limitações do sistema

O conector do Zendesk pode processar cinco transações por segundo, por nó, e limitar todas as transações além desse limite. Por padrão, os Integration Connectors alocam 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 dos conectores de integração será escalonado automaticamente 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. São necessários mais nós para processar mais transações para uma conexão. Por outro lado, menos nós serão necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de 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ê é um cliente de 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 de processamento, 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

Nesta seção, descrevemos como executar algumas das ações nesse conector.

Exemplo: excluir um tíquete

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DeleteTicketsPermanently 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:
```
{
  "Id": "18"
}
```

Neste exemplo, o ingresso é excluído permanentemente. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
  "Success": "true"
}]

Observação : a operação DeleteTicketsPermanently exclui um registro permanentemente. Para fazer uma exclusão reversível, use a operação de exclusão de entidades.

Exemplo: mesclar tíquetes

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação MergeTickets 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:
```
{
  "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 do conector terá um valor semelhante a este:

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

Exemplo: restaurar um tíquete

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação RestoreTicket 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:
```
{
  "id": "20"
}
```

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

[{
  "Success": "true"
}]

Exemplo: recuperar um tíquete suspenso

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação RecoverSuspendedTicket 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:
```
{
  "id": "18726501985809"
}
```

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

[{
  "Id": "60921"
}]

Exemplos de operação de entidade

Exemplo: listar todos os ingressos

Neste exemplo, listamos todos os ingressos na entidade Tickets.

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

Exemplo: receber um ingresso

No exemplo, temos o tíquete com o ID 35 da entidade Tickets.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Tickets 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 35 no campo Valor padrão.
Aqui, 35 é o valor da chave primária da entidade Tickets.

Exemplo: criar um tíquete

Neste exemplo, um tíquete é criado na entidade Tickets.

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

{
    "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 a este:

 {
    "Id": 38.0
  }

Exemplo: atualizar um tíquete

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

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

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

Clique em entityId e, em seguida, insira 35 no campo Valor padrão.
Como alternativa, em vez de especificar o entityId, você também pode definir o filterLesson como 35.

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

Exemplo: excluir um tíquete

Neste exemplo, o tíquete com o ID 35 na entidade Tickets é excluído.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Ingressos" 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 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 o registro excluído posteriormente.

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
proxy_enabled	BOOLEAN	Falso	Marque essa 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 ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticação no proxy 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 do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

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