Resumo

Um token de API permite que sistemas externos, como plataformas de Gestão de Relacionamento com o Cliente (CRM) ou aplicativos personalizados, conectem-se com segurança ao Wati e acessem suas APIs. Este guia explica como gerar um token de API no Wati, escolher as permissões corretas e armazenar o token com segurança para uso futuro.

Instruções

Siga os passos abaixo para gerar um novo token de API em sua conta Wati.

Passo 1: Faça login na sua conta Wati

  • Faça login na sua conta Wati.

Passo 2: Vá para a página de Tokens de API

  • Vá para Connector (Conector) > API Tokens (Tokens de API)

Passo 3: Gere um novo token de API

  • Na página API Tokens, clique em Generate new token (Gerar novo token).

  • Insira um nome para o token para identificá-lo.

Passo 4: Selecione as permissões necessárias (escopos)

Escolha as permissões que sua integração precisa. Essas permissões são chamadas de escopos (scopes) e definem o que o token tem permissão para acessar.

Exemplos de escopos usados com frequência incluem:

  • contacts:read — Permite a leitura de dados de contatos

  • contacts:write — Permite criar ou atualizar contatos

  • messagetemplate:read — Permite a leitura de informações de modelos de mensagem

Selecione apenas os escopos necessários para sua integração, a fim de aumentar a segurança.

Passo 5: Defina uma data de validade (opcional)

Você pode definir uma data de validade para o token. Isso ajuda a reduzir os riscos de segurança ao limitar por quanto tempo o token permanece ativo.

Para maior segurança, é recomendado renovar (rotacionar) os tokens de API a cada 6 meses.

Passo 6: Copie e armazene o token com segurança

Após a geração do token:

  • Copie o token imediatamente.

  • Armazene-o com segurança em seu gerenciador de senhas ou ambiente protegido.

Importante: O token é exibido apenas uma vez no momento da geração. Se você perdê-lo, precisará gerar um novo token.

Observações:

  • A opção Create New Token (Criar novo token) remove dependências em nível de usuário, o que significa que o token não depende de uma conta de usuário específica.

  • O token permanecerá ativo até:

    • Atingir a data de validade, ou

    • Ser atualizado ou revogado manualmente.

  • Escopos de API necessários: Os endpoints da API V3 exigem os escopos V3 correspondentes. Por exemplo, contactsv3:*, conversationsv3:* e messagetemplatev3:write.

  • Requisitos de escopo: Cada endpoint aceita qualquer um dos escopos listados para ele. Certifique-se de que seu token de API tenha pelo menos um dos escopos necessários. Um erro 403 Forbidden também pode ocorrer se sua função de usuário ou plano de assinatura não tiver as permissões necessárias.

  • Nomenclatura de escopos: Os escopos da API Wati usam o prefixo wati_. Inclua este prefixo ao configurar ou referenciar os escopos necessários.

Manter seus tokens de API seguros ajuda a proteger suas integrações e evita o acesso não autorizado à sua conta Wati.

Perguntas Frequentes (FAQs)

Noções básicas e permissões de tokens de API

1. O que é um token de API no Wati?

Um token de API permite que sistemas externos, como plataformas de CRM ou aplicativos personalizados, conectem-se com segurança ao Wati e acessem suas APIs.

2. O que são escopos de tokens de API no Wati?

Escopos de tokens de API são permissões que definem quais recursos e operações do Wati uma integração pode acessar. Por exemplo, os escopos podem permitir que uma integração leia dados de contatos, crie ou atualize contatos ou leia informações de modelos de mensagem.

3. Quais escopos de API são necessários para os endpoints da API V3 do Wati?

Os endpoints da API V3 do Wati exigem os escopos V3 correspondentes. Exemplos incluem contactsv3:*, conversationsv3:* e messagetemplatev3:write. Cada endpoint de API aceita qualquer um dos escopos listados como necessários para esse endpoint. Seu token de API deve incluir pelo menos um desses escopos necessários.

4. Por que estou recebendo um erro 403 Forbidden ao usar um token de API do Wati?

Um erro 403 Forbidden pode ocorrer se o seu token de API não incluir pelo menos um dos escopos necessários para o endpoint da API. Isso também pode ocorrer se a sua função de usuário ou plano de assinatura não possuir as permissões necessárias.

Validade e segurança do token de API

5. Um token de API do Wati expira automaticamente?

Um token de API do Wati permanece ativo até atingir a data de validade configurada ou ser atualizado ou revogado manualmente. Definir uma data de validade é opcional e ajuda a limitar o tempo em que o token permanece ativo.

6. Posso recuperar meu token de API do Wati depois de gerá-lo?

Não. O Wati exibe um token de API apenas uma vez, imediatamente após a geração. Copie e armazene o token com segurança no momento em que ele for gerado. Se você perder o token, deverá gerar um novo. O Wati recomenda a renovação (rotação) dos tokens de API a cada 6 meses para maior segurança.

Did this answer your question?