Zendesk

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

Versões suportadas

Este conetor suporta as APIs da versão 2 do Zendesk.

Antes de começar

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

  • Se estiver a usar o token de API como método de autenticação para aceder à API Zendesk, obtenha um token de API no centro de administração do Zendesk. Depois de gerado, guarde o token da API em segurança na gestão de chaves de Google Cloud. Para mais informações, consulte o artigo Gerir o acesso ao token da API à API Zendesk.
  • Para ver informações sobre a criação de uma conta do Zendesk, consulte o artigo Crie uma conta do Zendesk.
  • Para criar uma subscrição de eventos do Zendesk, tem de ter uma função de administrador na sua conta do Zendesk. A sua conta do Zendesk tem de ter um plano Suite growth and above ou Support professional and above, uma vez que esta funcionalidade não está disponível para contas de avaliação.

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. Clicar em Seguinte.
  4. Na secção Detalhes da associação, conclua o seguinte:
    1. Conetor: selecione Zendesk 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.
      • Para os conetores que suportam a subscrição de eventos, os nomes das associações não podem começar com o prefixo "goog".
    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. Para usar a associação para subscrições de eventos, selecione Ativar subscrição de eventos. Se selecionar esta opção, são apresentadas as seguintes opções:
      • Ativar subscrição de eventos com entidade e ações: selecione esta opção para usar a associação para a subscrição de eventos e as operações do conetor (entidades e ações).
      • Ativar apenas subscrição de eventos: selecione esta opção para usar a associação apenas para a subscrição de eventos. Se selecionar esta opção, clique em Seguinte e, de seguida, configure a subscrição de eventos.
    8. 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.

    9. (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:

    10. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
    11. Clicar 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.

      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. Clicar em Seguinte.
  6. 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 Zendesk:

      • Nome de utilizador e palavra-passe (descontinuado)
      • Chave da API
      • OAuth 2.0 – Código de autorização

      2. Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

    2. Clicar em Seguinte.
  7. Se tiver ativado a subscrição de eventos, a secção Detalhes da subscrição de eventos é apresentada na página de criação da associação. Para compreender como configurar os detalhes da subscrição de eventos, consulte o artigo Configure a subscrição de eventos.
  8. Rever: reveja os detalhes da ligação e da autenticação.
  9. Clique em Criar.

Configure a autenticação

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

  • Nome de utilizador e palavra-passe (descontinuado)
    • Nome de utilizador: o nome de utilizador do Zendesk a usar para a associação.
    • Palavra-passe: Secret do Secret Manager que contém a palavra-passe associada ao nome de utilizador do Zendesk.
  • Token da API
    • Utilizador: a conta de utilizador do Zendesk usada para autenticação.
    • Token da API: o token da API do utilizador autenticado.
    • Versão do Secret: versão do Secret para o segredo.
  • OAuth 2.0 – Código de autorização
    • ID de cliente: o ID de cliente fornecido pelo conector para a app que criou.
    • Âmbitos: uma lista separada por vírgulas dos âmbitos pretendidos.
    • Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente para a app associada que criou.
    • Versão do Secret: versão do Secret para o segredo.
    • URL de autorização: URL de autorização gerado quando cria o cliente na instância do Zendesk.

Configure a subscrição de eventos

Se ativou a subscrição de eventos, introduza os seguintes valores na secção Detalhes da subscrição de eventos:

  1. Selecione um Tipo de destino.
    • Endereço do anfitrião: introduza o URL de registo do seu sistema de back-end no campo anfitrião.
  2. Selecione Token de API como tipo de autenticação. Não selecione Nome de utilizador e palavra-passe.
  3. Introduza os detalhes de autenticação.
    1. Utilizador: a conta de utilizador do Zendesk usada para autenticação.
    2. Token da API: o token da API do utilizador autenticado.
    3. Versão do Secret: versão do Secret para o segredo.
  4. Opcionalmente, selecione Ativar enriquecimento de dados se quiser que sejam anexadas informações adicionais à resposta do sistema de back-end.

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

  5. Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
  6. Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
    1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
    2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.
  7. Se quiser usar um proxy para estabelecer ligação ao seu back-end (para a subscrição de eventos), introduza os seguintes detalhes:
    1. Tipo de SSL do proxy: o tipo de SSL a usar quando se liga ao servidor proxy. Selecione qualquer um dos seguintes tipos de autenticação:
      • Sempre: a ligação está sempre ativada com SSL para a subscrição de eventos.
      • Nunca: a ligação não tem o SSL ativado para a subscrição 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 suportados:
      • Básica: autenticação HTTP básica.
    3. Utilizador do proxy: introduza o nome de utilizador a usar para a autenticação junto do servidor proxy.
    4. Palavra-passe do proxy: selecione o segredo do Secret Manager da palavra-passe do utilizador.
    5. Versão do Secret: selecione a versão do Secret.
    6. Na secção Servidor proxy, introduza os detalhes do servidor proxy.
      1. Clique em + Adicionar destino e, de seguida, selecione o Tipo de destino como Endereço do anfitrião.
      2. Introduza o nome de anfitrião ou o endereço IP do servidor proxy e o número da porta do servidor proxy.

Exemplos de configuração de ligação

Tipo de ligação de autenticação básica (obsoleto)

Nome do campo Detalhes
Localização us-east4
Conetor Zendesk
Versão do conetor 1
Nome da ligação CONNECTION_NAME
Ative o Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Anfitrião HOST_ADDRESS
UserPassword Sim
Nome de utilizador NOME DE UTILIZADOR
Palavra-passe PASSWORD
Versão do Secret 1

Tipo de ligação de chave da API

Nome do campo Detalhes
Localização europe-west1
Conetor Zendesk
Versão do conetor 1
Nome da ligação zendesk-apitoken
Ative o Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do anfitrião
Host1 https://yoursubdomain.zendesk.com
Autenticação Chave da API
Utilizador Nome de utilizador
Chave da API Símbolo da API fornecido pela sua app
Versão do Secret 1

OAuth 2.0 – Tipo de ligação de código de autorização

Nome do campo Detalhes
Localização europe-west1
Conetor Zendesk
Versão do conetor 1
Nome da ligação zendesk-auth-code
Ative o Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do anfitrião
Host1 https://yoursubdomain.zendesk.com
Autenticação OAuth 2.0 – Código de autorização
ID do cliente CLIENT_ID
Âmbitos Âmbitos obrigatórios de acordo com o seu exemplo de utilização
Segredo do cliente CLIENT_SECRET
Versão do Secret 1
URL de autorização https://d3v2one1625553311.zendesk.com/oauth/authorizations/new

A ligação ao Zendesk usa SSL por predefinição e não é necessária nenhuma configuração adicional se estiver a usar o URL padrão do Zendesk, como https://yoursubdomain.zendesk.com.

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.

  • 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:

    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.

Limitações do sistema

O conector do Zendesk pode processar 5 transações 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.

Ações

O conector do Zendesk oferece ações para gerir os seus pedidos com base no ticket ID. Para compreender como configurar as ações, consulte os exemplos de ações.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: elimine um bilhete

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteTicketsPermanently e, de seguida, clique em Concluído.
  3. 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": "18"
}

    4. Este exemplo elimina o pedido permanentemente. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

    [{
  "Success": "true"
}]

Exemplo: unir pedidos

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação MergeTickets e, de seguida, clique em Concluído.
  3. 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": "25",
  "Id": "26"
}

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

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

Exemplo: restaure um bilhete

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RestoreTicket e, de seguida, clique em Concluído.
  3. 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": "20"
}

    4. Este exemplo restaura um registo. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

    [{
  "Success": "true"
}]

Exemplo: recupere um pedido suspenso

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RecoverSuspendedTicket e, de seguida, clique em Concluído.
  3. 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": "18726501985809"
}

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

    [{
  "Id": "60921"
}]

Exemplos de operações de entidades

Exemplo: apresentar operação em bilhetes

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

    4. Pode realizar a operação List nas seguintes entidades:

    Anexos, comentários de pedidos, formulários de pedidos, campos de pedidos, pedidos, auditorias de pedidos, métricas de pedidos, pedidos suspensos, acordos de partilha, utilizadores, identidades de utilizadores, informações relacionadas com o utilizador, campos de utilizadores, campos de organização e JobStatus

Exemplo: obter operação em bilhetes

  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, de seguida, clique em Concluído.
  4. Aqui, o entityId está definido como 34,0. Para definir o entityId, na secção Task Input da tarefa Connectors, clique em entityId e, de seguida, introduza 34.0 no campo Default Value.

    5. Pode executar a operação Get nas seguintes entidades:

    Ticket Forms, Ticket Fields, Requests, Ticket Audits, Suspended Tickets, User Fields, UserIdentities e Users

Exemplo: operação de criação em bilhetes

  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 Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value: 
    {
    "Subject": "Zendesk_Create_Ticket",
    "RawSubject": "Zendesk_Create",
    "Description": "this ticket is related to application integration Create operation",
    "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,
    "Tags": null,
    "ViaChannel": "web",
    "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
    "CustomFields": null,
    "SatisfactionRating": null,
    "SharingAgreementIds": null,
    "AllowChannelback": false,
    "IsPublic": true,
    "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json"
  }

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

     {
    "Id": 38.0
  }

Exemplo: operação de criação em TicketForms

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TicketForms 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: 
    {
    "Name": "Altostrat_Zendesk1",
    "RawName": "Altostrat_Zendesk1",
    "DisplayName": "Altostrat_Issues1",
    "RawDisplayName": "Altostrat_Issues1",
    "Position": 2.0,
    "Active": true,
    "EndUserVisible": true,
    "Default": false,
    "InAllBrands": true,
    "RestrictedBrandIds": null,
    "FallbackToDefault": null,
    "AssociatedToBrand": null
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:TicketFormsconnectorOutputPayload

    {
    "Id":1.8104712053393E13
  }

Exemplo: criar operação em TicketFields

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TicketFields 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: 
    {
    "Type": "text",
    "Title": "New field created",
    "RawTitle": null,
    "Description": "Please create the new field",
    "RawDescription": null,
    "Position": 2.0,
    "Active": true,
    "Required": false,
    "CollapsedForAgents": false,
    "RegexpForValidation": null,
    "VisibleInPortal": true,
    "EditableInPortal": true,
    "Tag": null,
    "CreatedAt": "2021-07-06 06:35:19.0",
    "UpdatedAt": "2021-07-06 06:35:19.0",
    "SystemFieldOptions": null,
    "CustomFieldOptions": null,
    "Removable": false
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:TicketFieldsconnectorOutputPayload

    {
    "Id": 1.7139061374865E13
  }

Exemplo: operação de criação em SharingAgreements

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SharingAgreements 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: 
    {
    "Name": "altostrat.zendesk.com",
    "RemoteSubdomain": "altostrat"
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:SharingAgreementsconnectorOutputPayload

    {
    "Id": 1.7142672288273E13
  }

Exemplo: operação de criação em utilizadores

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Users 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: 
    {
    "Email": "cloudysanfrancisco@gmail.com",
    "Name": "Altostrat Team"
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:UsersconnectorOutputPayload

    {
    "Id": 1.7156912480273E13
  }

Exemplo: operação de criação em UserIdentities

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione UserIdentities 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: 
    {
    "UserId": 3.84637722338E11,
    "Type": "email",
    "Value": "cloudysanfrancisco@gmail.com",
    "Verified": false,
    "Primary": true,
    "DeliverableState": "reserved_example",
    "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json"
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:UserIdentitiesconnectorOutputPayload

    {
    "Id": 1.6961185982353E13
  }

Exemplo: operação de criação em UserFields

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione UserFields 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: 
    {
    "Title": "Support description",
    "Type": "text",
    "Key": "support_description"
  }

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:UserFieldsconnectorOutputPayload

    {
    "Id": 1.7157236761873E13
  }

Exemplo: operação de atualização em Tickets

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Tickets 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: 
    {
    "Subject": "Google_Altostrat_Zendesk Update",
    "RawSubject": "Google_Altostrat_Zendesk Update",
    "Description": "this ticket is related to googlecloud application integration update check",
    "RequesterId": 1.6854335860497E13
  }
  5. Aqui, o entityId está definido como 35.0. Para definir o entityId, clique em entityId e, de seguida, introduza 35 no campo Valor predefinido.

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

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

    {
      Id": 35.0
  }

Exemplo: atualizar operação em TicketForms

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TicketForms 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: 
    {
    "Name": "Ticketforms Updated",
    "DisplayName": "Altostrat_Issues1",
    "RawDisplayName": "Altostrat_Issues1"
  }
  5. Aqui, o entityId está definido como 1.7137314972689E13. Para definir o entityId, clique em entityId e, de seguida, introduza 1.7137314972689E13 no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 1.7137314972689E13.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {
      Id": 1.7137314972689E13
  }

Exemplo: atualização da operação em TicketFields

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TicketFields 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": "Updated description for testing"
  }
  5. Aqui, o entityId está definido como 3.60022990118E11. Para definir o entityId, clique em entityId e, de seguida, introduza 3.60022990118E11 no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 3.60022990118E11.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {
      Id": 3.60022990118E11
  }

Exemplo: operação de atualização em utilizadores

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Users 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: 
    {
    "Name": "The Customer update",
    "Last Name": "Alex",
    "First Name": "Charlie"
  }
  5. Aqui, o entityId está definido como 3.84625885158E11. Para definir o entityId, clique em entityId e, de seguida, introduza 3.84625885158E11 no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 3.84625885158E11.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {
      Id": 3.84625885158E11
  }

Exemplo: operação de atualização em UserFields

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione UserFields 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: 
    {
    "Title": "Support description updated",
    "Type": "text",
    "Key": "support_description"
  }
  5. Aqui, o entityId está definido como 1.7157236761873E13. Para definir o entityId, clique em entityId e, de seguida, introduza 1.7157236761873E13 no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 1.7157236761873E13.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {
      Id": 1.7157236761873E13
  }

Exemplo: operação de atualização em UserIdentities

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione UserIdentities 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: 
    {
    "Verified": true
  }
  5. Nesta entidade, a operação de atualização pode ser realizada através da cláusula de filtro e das chaves primárias compostas. Por isso, não é necessário o entityId.

    6. Em vez de especificar o entityId, também pode definir a filterClause como UserId='384625885158' and Id='368234205078'.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída da tarefa do conetor:connectorOutputPayload

    {
    "Id": 3.68234205078E11
  }

Exemplo: operação de eliminação em bilhetes

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Tickets na lista Entity.
  3. Selecione a operação Delete e, de seguida, clique em Concluído.
  4. Aqui, o entityId está definido como 35.0. Para definir o entityId, na secção Task Input da tarefa Connectors, clique em entityId e, de seguida, introduza 35 no campo Default Value.

    5. Pode realizar a operação de eliminação nas seguintes entidades:

    Campos de pedidos, pedidos suspensos, UserIdentities, campos de utilizador e utilizadores

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
proxy_enabled BOOLEAN Falso Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme ENUM Falso O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

Use a ligação do Zendesk 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?