O que a REST API do Deskwoot pode fazer?

Atualizado em 20 de out. de 20263 min de leitura
Português
Nesta página

A REST API do Deskwoot dá acesso programático aos seus dados de suporte, para que você possa ler e criar conversas, gerenciar contatos, enviar e buscar mensagens, e conectar o Deskwoot às suas próprias ferramentas e scripts. É um recurso do Enterprise, e você autentica cada requisição com um token que cria em Configurações > Tokens de API.

O que você pode fazer com a API?

A REST API cobre os objetos do dia a dia da sua central de ajuda. Com os escopos de token corretos, você pode:

  • Conversas: listar, ler, criar e atualizar conversas, e mudar o status ou a atribuição delas.
  • Mensagens: buscar as mensagens de uma conversa e publicar novas respostas ou notas privadas.
  • Contatos: ler, criar e atualizar as pessoas que entram em contato, incluindo os atributos delas.
  • Relatórios: todos os números da página de relatórios (volume, tempo da primeira resposta e de resolução, CSAT) por agente, equipe, caixa de entrada, canal, etiqueta, status, prioridade, dia ou semana, com filtros combináveis e qualquer período, além de cada conversa e cada avaliação de CSAT em linhas ou CSV.

Isso faz da API uma boa opção para sincronizar chamados com um sistema interno, montar um painel personalizado, automatizar atualizações de rotina ou alimentar dados de conversas em outra ferramenta.

Qual plano inclui a REST API?

A REST API é um recurso do Enterprise, e os tokens de API só podem ser criados em um plano Enterprise pago. O teste de 7 dias do Enterprise com que toda conta nova começa não inclui tokens de API. Se você está em um plano inferior e precisa de acesso à API, será preciso estar no Enterprise.

Como obtenho um token?

Os tokens são criados e gerenciados em Configurações > Tokens de API. Dê a cada token um nome claro, conceda apenas os escopos de que a integração precisa, e copie-o assim que for gerado, já que o valor completo pode não ser mostrado de novo. Veja o guia de tokens de API para o passo a passo completo, incluindo a URL base e como passar o token no cabeçalho de autorização.

E se eu quiser um agente de IA em vez de escrever código?

Se o seu objetivo é deixar um agente de IA externo operar a central de ajuda, em vez de escrever sua própria integração, o servidor MCP pode ser uma opção melhor. Ele expõe um conjunto definido de ferramentas a um agente compatível com MCP por meio de um token de bot com escopo. Assim como a REST API, é um recurso do Enterprise, mas, ao contrário dos tokens de API, também funciona durante o teste Enterprise de 7 dias.

Perguntas frequentes

A REST API está disponível em todos os planos?
Não. A REST API é um recurso do Enterprise, e os tokens de API exigem um plano Enterprise pago. O teste Enterprise de 7 dias não inclui tokens de API.
O que posso acessar pela API?
Conversas, mensagens e contatos, entre outros dados da central de ajuda. Você pode ler e criar conversas, publicar respostas e notas e gerenciar contatos, sempre dentro das permissões do seu token.
Onde crio um token de API?
Em Configurações > Tokens de API. Dê um nome ao token, conceda só os escopos de que precisa e copie-o na hora, já que o valor completo pode não ser mostrado de novo.
Devo usar a REST API ou o servidor MCP?
Use a REST API para criar suas próprias integrações e scripts. Use o servidor MCP se você quer que um agente de IA externo opere a central de ajuda por meio de um token de bot com escopo. Os dois são recursos do Enterprise.
Posso levar os relatórios para o meu próprio painel?
Sim. Os endpoints de relatórios retornam os mesmos números da página de relatórios, filtrados por agente, equipe, caixa de entrada, canal, etiqueta, status e prioridade em qualquer período, agrupados por agente, etiqueta, dia, semana e mais, além de cada conversa e cada avaliação de CSAT em linhas. Chame-os do seu próprio servidor com um token com o escopo conversations:read. A referência completa está na documentação da API.

Este guia foi útil?

Continue lendo

Perguntar ao Fynn sobre este guia

Receba uma resposta curta deste guia e do resto da Central de Ajuda.

Ainda precisa de ajuda?

Fynn responde no chat a partir destes guias, e você também fala com a equipe por lá.

Enviar e-mail