Tokens de API e acesso para desenvolvedores

O Deskwoot oferece uma REST API que lhe dá acesso programático aos seus dados e fluxos de suporte. Seja para criar integrações personalizadas, sincronizar dados de tickets com ferramentas internas ou automatizar tarefas repetitivas, os tokens de API permitem que você se autentique com segurança sem compartilhar as suas credenciais de login. Este guia mostra como gerar tokens, fazer a sua primeira chamada de API e seguir as práticas que mantêm a sua conta segura.

A REST API é um recurso do plano Enterprise. Ela também está disponível durante o teste de 7 dias do Enterprise com o qual toda conta nova começa, para que você possa construir e testar antes de assumir o compromisso. Se você está em um plano inferior e precisa de acesso à API, será necessário estar no Enterprise. Para um panorama mais completo do que a API abrange, veja a visão geral da REST API.

Como eu gero um token de API?

Faça login na sua conta do Deskwoot e vá em Configurações > Tokens de API.
Clique na opção de criar um novo token.
Dê ao token um nome descritivo (por exemplo sincronização de CRM, produção) para que você possa identificar a finalidade dele depois.
Selecione as permissões específicas que o token deve ter. Conceda apenas os níveis de acesso de que a sua integração realmente precisa.
Confirme e copie o token imediatamente. Por motivos de segurança, o token completo pode não ser exibido de novo depois que você sair da página.

Como eu uso a API?

Todas as requisições à API são feitas para a seguinte URL base:

https://deskwoot.com/api/v1/

Inclua o seu token de API no cabeçalho Authorization de cada requisição:

Authorization: Bearer YOUR_TOKEN

Exemplo de requisição

Uma chamada cURL simples para testar a sua conexão pode ser assim:

curl -H "Authorization: Bearer YOUR_TOKEN" https://deskwoot.com/api/v1/

Se o token for válido, a API retorna uma resposta bem-sucedida. Se não, você recebe um erro de autenticação.

Quais são as melhores práticas?

Conceda o mínimo de acesso necessário. Atribua a cada token apenas as permissões de que ele precisa. Evite criar tokens com acesso total de administrador, a não ser que você realmente precise.
Rotacione os tokens com regularidade. Revogue periodicamente os tokens antigos e gere novos, especialmente quando membros da equipe mudam de função ou saem.
Armazene os tokens com segurança. Guarde os tokens em variáveis de ambiente ou em um gerenciador de segredos. Nunca os deixe fixos no código do lado do cliente nem os envie para o controle de versão.
Use nomes descritivos. Nomear os tokens conforme a integração ou o ambiente que eles servem torna a auditoria simples.
Monitore o uso. Revise os seus tokens ativos em Configurações > Tokens de API regularmente e exclua os que não estão mais em uso.

Como eu resolvo erros de token?

401 Unauthorized: Confira se o token foi copiado corretamente, se não foi revogado e se está incluído no cabeçalho com o prefixo Bearer.
403 Forbidden: O token pode não ter as permissões para o endpoint que você está chamando. Edite ou recrie o token com o acesso correto.
Limite de taxa: Se você receber erros de limite de taxa, reduza a frequência com que chama a API ou adicione recuo exponencial ao seu código.

Perguntas frequentes

A REST API está disponível em todos os planos?

Não. A REST API é um recurso do plano Enterprise, e também está disponível durante o teste de 7 dias do Enterprise. Os planos pagos inferiores não a incluem.

Posso criar vários tokens de API?

Sim. Você pode gerar quantos tokens precisar. Recomenda-se criar um token separado para cada integração ou ambiente, para que você possa revogar um sem afetar os outros.

O que acontece se o meu token for comprometido?

Vá em Configurações > Tokens de API imediatamente, revogue o token comprometido e gere um novo. Atualize quaisquer serviços que dependiam do token antigo.

E se eu quiser que um agente de IA use a central de suporte?

Se você quer que um agente de IA externo opere o Deskwoot em vez de construir a sua própria integração, veja o servidor MCP. Ele também é um recurso do plano Enterprise e usa tokens de bot com escopo restrito.