Como usar a API de Chat no Zendesk: Um guia passo a passo

Então, você está querendo criar uma integração personalizada, extrair alguns dados de chat para um relatório ou automatizar alguns fluxos de trabalho no Zendesk. Esse é um ótimo objetivo. Usar a API oferece o poder de realmente personalizar a plataforma para atender às necessidades específicas da sua equipe.

O Zendesk é uma plataforma madura e confiável, e parte dessa força vem da ampla variedade de ferramentas de desenvolvedor que ele oferece. Esteja você trabalhando com o Live Chat clássico ou com a nova plataforma de Messaging, o Zendesk fornece um verdadeiro buffet de diferentes APIs para escolher: REST, Real-Time (Tempo Real) e muito mais. Embora ter tantas opções mostre a profundidade da plataforma, ajuda muito ter um guia para encontrar o ponto de partida ideal.

Este guia está aqui para ajudá-lo a navegar por essas ferramentas poderosas. Vamos percorrer um processo claro, passo a passo, para usar a API de Chat clássica que o Zendesk fornece. Mostraremos como escolher as ferramentas certas para seus objetivos e levaremos você dos primeiros passos até a realização da sua primeira chamada de API com sucesso.

O que você precisará para começar com a API de Chat do Zendesk

Antes de mergulharmos nos passos, vamos fazer uma verificação rápida para garantir que você tenha tudo o que precisa. Resolver isso agora tornará o processo muito mais tranquilo.

Aqui está uma lista de verificação rápida:

• Uma conta Zendesk com acesso à API. Isso está disponível nos planos Zendesk Suite Team e superiores. O Zendesk oferece planos em níveis para se adaptar a diferentes tamanhos e necessidades de equipe.

• Permissões de administrador. Você precisará ser um administrador na sua conta Zendesk para gerar as chaves de API. Isso garante que suas integrações sejam tratadas com segurança.

• Um cliente de API. Você precisará de uma maneira de enviar solicitações para a API. Uma ferramenta como o Postman é fantástica para isso, pois permite testar chamadas de API com uma interface profissional. Alternativamente, você pode usar o cURL diretamente no seu terminal ou usar sua linguagem de programação favorita.

• Conhecimento básico de APIs REST. Ter uma familiaridade básica com conceitos como endpoints, solicitações GET e cabeçalhos de autorização ajudará você a aproveitar ao máximo o robusto ecossistema de desenvolvedores do Zendesk.

Um guia passo a passo para usar a API de Chat do Zendesk

Certo, agora que você já tem todas as suas ferramentas prontas, vamos ao que interessa. Começaremos analisando o cenário do Zendesk e depois passaremos para uma chamada de API real.

Passo 1: Entenda o cenário da API de Chat do Zendesk (Chat vs. Messaging)

O Zendesk oferece um conjunto abrangente de ferramentas de comunicação, incluindo dois produtos de chat distintos: Live Chat e Messaging. Ambos são soluções poderosas, e entender qual você está usando ajudará você a escolher a API correta.

Zendesk Live Chat (O Clássico) Este é o produto de chat original, baseado em sessões, que alimenta o atendimento ao cliente em tempo real para milhares de empresas. É perfeito para conversas imediatas e ao vivo. Este produto usa um conjunto específico de APIs, incluindo a Chat REST API, na qual focaremos neste guia. Essas APIs foram criadas para gerenciar essas conversas em tempo real, lidar com agentes e extrair logs históricos de chat.

Zendesk Messaging Esta é a abordagem moderna e omnichannel do Zendesk. Ela foi criada para conversas assíncronas, permitindo que os clientes se comuniquem via web, celular ou canais sociais como o WhatsApp no seu próprio ritmo. O Messaging utiliza seu próprio kit de ferramentas avançado para desenvolvedores, incluindo o Sunshine Conversations.

Passo 2: Escolha a API certa para o seu objetivo

Dentro do ambiente Live Chat, o Zendesk oferece várias APIs especializadas, cada uma otimizada para uma tarefa específica.

Aqui está um resumo rápido das suas opções:

• Chat REST API: Esta é uma ferramenta versátil que você usará para a maioria das tarefas. Use-a para obter programaticamente dados históricos de chat, buscar transcrições, gerenciar seus agentes e atualizar informações de chat. Usaremos esta em nosso exemplo.

• Real-Time Chat API: Esta é uma API de streaming de alto desempenho criada para monitoramento em tempo real. Se você precisa de um painel que mostre chats ativos ou o status do agente em tempo real, esta é a escolha perfeita.

• Conversations API (GraphQL): Embora esta API tenha sido usada para construir aplicativos semelhantes a agentes, o Zendesk agora está focando o desenvolvimento em ferramentas mais novas. Atualmente, ela está em modo de manutenção, portanto, recomenda-se usar a API REST para novos projetos.

• Web SDK: Esta é uma biblioteca JavaScript que permite construir um widget de chat completamente personalizado, oferecendo controle total sobre a experiência do usuário em seu site.

Para tornar ainda mais claro, aqui está uma tabela simples dessas opções:

Nome da API	Tipo	Caso de Uso Principal	Status
Chat REST API	REST	Recuperação de dados históricos, gerenciamento de chats	Ativa
Real-Time Chat API	REST / Streaming	Monitoramento de métricas ao vivo e status de agentes	Ativa
Conversations API	GraphQL	Construção de bots e apps tipo agente	Modo de Manutenção
Web SDK	JavaScript	Construção de um widget de chat front-end personalizado	Ativa

Passo 3: Gere suas credenciais de API

Para interagir com a API de forma segura, você criará um cliente OAuth no seu painel do Zendesk Chat. Esta é uma forma padrão e segura de gerenciar o acesso.

Veja como fazer:

1. Acesse o seu painel do Zendesk Chat. Você pode encontrá-lo na bandeja de produtos na sua conta principal do Zendesk Support.

2. Navegue até Configurações > Conta e clique na aba API e SDKs.

3. Clique no botão Adicionar Cliente API.

4. Dê ao seu cliente um Nome do Cliente (como "Integração de Dados de Chat") e insira o nome da sua Empresa. Para as URLs de redirecionamento, você pode inserir "https://localhost" para esta configuração.

5. O Zendesk gerará um ID de Cliente (Client ID) e um Segredo de Cliente (Client Secret). Certifique-se de salvar o Segredo do Cliente com segurança.

6. Essas credenciais permitirão que você gere um token de acesso para suas solicitações. Para este guia, assumiremos que você já tem seu token de acesso pronto.

Passo 4: Faça sua primeira chamada de API

Agora a parte emocionante. Vamos usar suas credenciais para extrair uma lista dos seus chats mais recentes.

O Endpoint Para obter uma lista de todos os chats, o endpoint é "GET /api/v2/chats".

Autenticação Você incluirá seu token de acesso em um cabeçalho "Authorization" usando o formato: "Authorization: Bearer SEU_TOKEN_DE_ACESSO".

Usando cURL Execute este comando no seu terminal, substituindo SEU_TOKEN_DE_ACESSO pelo seu token real:

curl https://www.zopim.com/api/v2/chats \
  -H "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

A infraestrutura confiável do Zendesk responderá com uma lista de seus chats em formato JSON.

Exemplo de Resposta Você verá uma resposta detalhada como esta:

{
  "chats": [
    {
      "id": "1A2B3C4D5E",
      "visitor": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      },
      "history": [
        {
          "type": "chat.msg",
          "display_name": "Jane Doe",
          "msg": "Olá, tenho uma dúvida sobre meu pedido recente.",
          "timestamp": 1678886400000
        },
        {
          "type": "chat.msg",
          "display_name": "Agente de Suporte",
          "msg": "Olá Jane, ficarei feliz em ajudar com isso!",
          "timestamp": 1678886460000
        }
      ],
      "timestamp": "2026-03-15T12:00:00Z"
    }
  ],
  "count": 1
}

Você usou com sucesso a API de Chat que o Zendesk fornece! Agora você tem acesso aos detalhes do visitante, histórico de conversas e muito mais.

Dicas para uma experiência tranquila com a API de Chat do Zendesk

À medida que você constrói integrações mais avançadas, manter essas melhores práticas em mente ajudará você a aproveitar ao máximo as capacidades do Zendesk.

• 1. Escolha a API Correspondente ao Seu Produto: Como o Zendesk oferece ferramentas especializadas tanto para Live Chat quanto para Messaging, sempre verifique qual produto você está segmentando. Isso garante que seu código funcione perfeitamente desde o primeiro dia.

• 2. Respeite os Limites de Taxa para Estabilidade: Para garantir o alto desempenho para todos os usuários, a API de Chat do Zendesk tem um limite de taxa (rate limit). Geralmente, é em torno de 200 solicitações por minuto. Você pode monitorar facilmente o cabeçalho "X-Rate-Limit-Remaining" na resposta para gerenciar suas chamadas de forma eficaz.

• 3. Foque em APIs Modernas: O Zendesk está em constante inovação. Ao usar suas APIs ativamente suportadas, como a Chat REST API, você garante que seu projeto seja construído sobre as bases mais recentes e ricas em recursos.

O ecossistema do Zendesk é vasto e poderoso, fornecendo tudo o que você precisa para construir um suporte de classe mundial. Se você deseja adicionar uma camada extra de eficiência, ferramentas como o eesel AI podem complementar sua configuração do Zendesk. Ele oferece um motor de simulação que permite ver como uma IA lidaria com tickets baseada em seus dados históricos, permitindo que você implemente a automação com ainda mais confiança.

Pule o código da API de Chat do Zendesk e automatize com IA

Parabéns! Você explorou a API de Chat que o Zendesk fornece e aprendeu como gerar credenciais e extrair dados. Esta é uma excelente maneira de personalizar seu ambiente.

Se você deseja aumentar ainda mais a eficiência do seu agente e fornecer resoluções instantâneas, também existem opções prontas para uso que funcionam dentro do ecossistema Zendesk.

O eesel AI é uma ferramenta especializada que se integra à sua instância do Zendesk em minutos. Ele oferece recursos complementares, como um agente autônomo e um AI Copilot para apoiar seus agentes humanos. É uma ótima maneira de adicionar uma automação poderosa enquanto aproveita a base sólida que o Zendesk já construiu para sua equipe.

Comece seu teste gratuito hoje mesmo.