Este tutorial abrange as informações apresentadas nas abas Documentação, Testar API, e Chave de API.
1. Chave de API (Token de Autenticação)
A chave de API é essencial para autenticar todas as suas requisições.
Objetivo: Obter e proteger seu Token de autenticação.
| Passo | Ação | Detalhes |
| 1 | Acesse a aba “Chave de API” | É a última aba na seção “API WAsap”. |
| 2 | Visualize o Token | O campo “Token” exibirá sua chave. |
| 3 | Copie o Token | Clique no botão “COPIAR TOKEN” para salvar o token na sua área de transferência. |
| 4 | Configure a Autenticação | Use o Token em todas as suas requisições HTTP, no cabeçalho Authorization, no formato: Authorization: Bearer seu_token_aqui. |
| 5 | Segurança | Nunca compartilhe seu token publicamente. Use variáveis de ambiente e regenere o token imediatamente caso suspeite de comprometimento. |
| 6 | Regenerar Token (Opcional) | Se necessário, clique em “REGENERAR”. Atenção: Isso invalidará o token anterior, fazendo com que todas as aplicações que o utilizam parem de funcionar até serem atualizadas com o novo token. |
2. Documentação da API
Esta seção oferece uma visão geral técnica sobre como interagir com a API WAsap para o envio de mensagens.
Objetivo: Entender a estrutura da requisição e os parâmetros.
| Seção | Detalhes Importantes |
| Autenticação | O Token (Bearer Token) deve ser enviado no cabeçalho Authorization. A documentação informa um alerta: “Nunca compartilhe seu token publicamente (quando ver espessurado nas configurações de envio)”. |
| URI de Mensagens | A URL para envio de mensagens é: POST {{url}}/api/mensagens/wasap. |
| Parâmetros Obrigatórios (Request Body – JSON) | * telefone: Número do WhatsApp do destinatário (com código do país e área, ex: 5561999990000). * mensagem: O texto que será enviado. * whatsappid: ID do WhatsApp usado para o envio. |
| Parâmetros Opcionais | * setor: Setor responsável. * midia: URL da mídia (imagem, áudio, vídeo, documento). |
| Exemplo de Requisição | É fornecido um exemplo de um payload JSON para o envio de mensagem de texto. |
| Exemplo de Resposta (Sucesso – 200) | É fornecido um exemplo de resposta para uma requisição bem-sucedida. |
| Tratamento de Erros | São listados códigos de erro comuns (ex: 400 – Requisição inválida, 401 – Não Autorizado, 429 – Limite de taxa excedido, 500 – Erro interno do servidor) e suas descrições. |
| Rate Limiting (Limite de Taxa) | Há um limite de requisições por minuto para garantir a estabilidade do serviço. |
| Boas Práticas | Recomendação de sempre utilizar HTTPS, implementar retry com backoff exponencial e monitorar logs de erros. |
3. Testar API (Envio de Mensagem por Formulário)
Esta aba permite testar o envio de mensagens de texto ou mídia de forma fácil, preenchendo um formulário.
Objetivo: Testar o envio de mensagens rapidamente.
| Campo do Formulário | Detalhes e Formato | Referência Rápida (Direita) |
| Número de telefone* | Formato: País + Área + Número (ex: 55999990000) | Telefone: Número do WhatsApp incluindo código do país. |
| Corpo da mensagem* | O texto da mensagem. | Mensagem: Texto que será enviado. |
| WhatsApp ID | O ID do WhatsApp que será usado para o envio. (Deve ser configurado na seção “Configurações da Mensagem”) | Whatsapp ID: Cloud WhatsApp usado. |
| Setor ID | O ID do Setor responsável. (Deve ser configurado na seção “Configurações da Mensagem”) | Setor: Setor responsável. |
| User ID | O ID do Usuário (Atendente). (Deve ser configurado na seção “Configurações da Mensagem”) | Não listado, mas faz parte das Configurações de Mensagem. |
| Mídia (Opcional) | Use “SELECIONAR ARQUIVO” ou forneça a URL. | Mídia: Arquivo para envio (opcional). |
| Tipos de Mídia Suportados | Imagens (JPG, PNG, WEBP), Áudio (MP3, OGG, WAV), Vídeos (MP4, AVI), Documentos (PDF, DOC, DOCX, XLS, XLSX). |
Conclusão e Próximo Passo
Você tem todas as informações necessárias para integrar sua aplicação: o Token de autenticação, a URL da API e os parâmetros necessários.
O próximo passo seria tentar enviar sua primeira mensagem usando um cliente HTTP (como Postman) ou integrando a API diretamente ao seu código.