WhatsMark SaaS — Visão Geral
Template de documentação com estrutura moderna para guias de integração, endpoints e exemplos de uso via WhatsApp.
Objetivo
Fornecer referências rápidas, exemplos e endpoints para integrar serviços WhatsApp.
Ambiente
Ambientes: sandbox, staging, produção — com chaves e tokens separados.
Início Rápido
- Crie sua conta e obtenha as credenciais (API key).
- Configure webhook para receber eventos de mensagens.
- Teste endpoints com ferramentas como curl ou Postman.
// Exemplo rápido (curl)
curl -X POST "https://api.exemplo.com/v1/messages" \
-H "Authorization: Bearer SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"to":"+5511999999999","text":"Olá, esse é um teste."}'
Integração
Fluxo básico: autenticação → envio de mensagem → confirmação de entrega → webhook de eventos.
Webhook
Configure uma URL pública para receber eventos (mensagem recebida, status de entrega, erros).
POST /webhooks/events
{
"event": "message_received",
"data": { ... }
}
Autenticação
Use Bearer token em header Authorization. Gire chaves periodicamente.
Authorization: Bearer SUA_API_KEY
API — Endpoints principais
| Endpoint | Método | Descrição |
|---|---|---|
| /v1/messages | POST | Enviar mensagem (texto, mídia, template). |
| /v1/messages/{id} | GET | Consultar status de uma mensagem. |
| /v1/contacts | GET | Listar contatos sincronizados. |
Exemplo de requisição (fetch)
fetch('https://api.exemplo.com/v1/messages', {
method: 'POST',
headers: {
'Authorization': 'Bearer SUA_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ to: '+5511999999999', text: 'Olá!' })
}).then(r => r.json()).then(console.log)
Exemplos
Trechos de código, templates de mensagens e fluxos de menu.
Template de menu interativo (exemplo)
{
"type": "interactive",
"body": { "text": "Escolha uma opção:" },
"actions": {
"buttons": [
{"id":"order","title":"Fazer pedido"},
{"id":"menu","title":"Ver cardápio"}
]
}
}
FAQ
Como faço testes sem custo?
Utilize o ambiente sandbox e números de teste fornecidos pela plataforma de integração.
Posso enviar mídia?
Sim — envie URLs públicas ou carregue arquivos via endpoint de upload.
Suporte & Contato
Para ajuda técnica, abra um ticket ou contate sua equipe de suporte. Exemplo de endpoint para geração de ticket:
POST /v1/support/tickets
{ "subject":"Erro ao enviar mensagem", "body":"Detalhes..." }