Documentacao da API

Integre WhatsApp, SMS e Email em minutos

APIs REST v4 simples, documentadas e prontas para producao. Autenticacao JWT, webhooks, envio em massa e muito mais.

  • Autenticacao JWT Bearer segura
  • Webhooks em tempo real para todos os eventos
  • Sandbox gratuito, sem cartao de credito necessario
  • Documentacao completa OpenAPI 3.0
Inicio rapido

Integre em 3 passos

De zero a mensagens enviadas em menos de 10 minutos.

1

Obtenha seu token

Chame o endpoint de autenticacao com suas credenciais para obter um token JWT para usar em todas as solicitacoes subsequentes.

POST /api/v4/auth/token
{"username":"...","password":"..."}
→ {"token": "eyJh..."}
2

Envie sua primeira mensagem

Use o token no cabecalho Authorization e chame o endpoint para enviar uma mensagem WhatsApp, SMS ou Email.

POST /whatsapp/chats/{id}/message
Authorization: Bearer <token>
→ {"status": "sent"}
3

Receba eventos

Configure um webhook para receber mensagens recebidas, confirmacoes de entrega e atualizacoes de status em tempo real.

POST /api/v4/webhooks/create
"url": "https://your-app.com/hook"
→ {"status": "active"}
Seguranca

Autenticacao JWT Bearer

Todas as APIs da Chat API usam tokens JWT. Gere seu token com uma unica chamada POST e inclua-o no cabecalho Authorization de cada solicitacao.

Expiracao configuravel

Os tokens expiram apos um periodo configuravel. Regenere automaticamente via API sem interrupcao.

HTTPS necessario

Todas as comunicacoes acontecem via HTTPS com TLS 1.2+. Nenhuma chamada em texto simples e aceita.

Credenciais seguras

Nome de usuario e senha sao trocados apenas uma vez para obter o token usado nas chamadas de API.

POST /api/v4/auth/token
{
  "username": "your@email.com",
  "password": "your-password"
}
200 OK Response
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "expiresIn": 3600,
  "type": "Bearer"
}
Use o token em cada solicitacao
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
Endpoints

Todos os endpoints disponiveis

Cada endpoint e documentado com parametros, respostas e exemplos em nossa documentacao OpenAPI.

WhatsApp
POST

Enviar mensagem

/api/v4/whatsapp/chats/{id}/message

Envie uma mensagem WhatsApp direta

GET

Listar modelos

/api/v4/notifications/whatsapp/templates

Veja modelos WhatsApp aprovados

POST

Notificacao de modelo

/api/v4/whatsapp/notifications

Envie notificacao individual fora da janela de 24h

POST

Envio em massa

/api/v4/whatsapp/bulk

Envie para milhares de contatos em um unico lote

SMS
POST

Enviar SMS

/api/v4/sms/send

Envie um SMS para qualquer numero no mundo

POST

Campanha SMS

/api/v4/sms/bulk

Envio em massa para listas de contatos

GET

Relatorio de entrega

/api/v4/sms/reports/{id}

Verifique o status de entrega

Email
POST

Enviar email

/api/v4/email/send

Email transacional com DKIM/SPF

POST

Campanha de email

/api/v4/email/bulk

Envie campanhas de marketing em massa

GET

Eventos de email

/api/v4/email/events

Taxa de abertura, cliques, rejeicoes, descadastros

Sistema
POST

Autenticacao

/api/v4/auth/token

Gere token JWT Bearer

POST

Webhooks

/api/v4/webhooks/create

Configure a recepcao de eventos em tempo real

POST

Widget de Chat

/api/v4/iframes/whatsapp/chat-box

Gere um iframe para o chat WhatsApp

Exemplos de codigo

Integre na sua linguagem

Exemplos prontos para autenticar e enviar sua primeira mensagem.

cURL
curl -X POST \
  https://app.roxpay.eu/api/v4/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username":"...","password":"..."}'

# Use the token:
curl -X POST \
  .../whatsapp/chats/123/message \
  -H "Authorization: Bearer <token>" \
  -d '{"body":"Hello!"}'
Python
import requests

# Authentication
r = requests.post(
  "https://app.roxpay.eu/api/v4/auth/token",
  json={"username":"...", "password":"..."}
)
token = r.json()["token"]

# Send message
requests.post(
  "...whatsapp/chats/123/message",
  headers={"Authorization": f"Bearer {token}"},
  json={"body": "Hello!"}
)
Node.js
// Authentication
const r = await fetch(
  "https://app.roxpay.eu/api/v4/auth/token",
  { method: "POST",
    headers: {"Content-Type":"application/json"},
    body: JSON.stringify({username,password}) }
);
const { token } = await r.json();

// Send message
await fetch("...chats/123/message", {
  method: "POST",
  headers: { Authorization: `Bearer ${token}` },
  body: JSON.stringify({ body: "Hello!" })
});
Ambientes

Sandbox e producao

Teste livremente no ambiente sandbox sem custo, depois mude para producao com uma unica mudanca de URL. Zero refatoracao.

Sandbox gratuito

Sem creditos consumidos. Mensagens simuladas. Testes ilimitados sem configuracao extra.

Producao escalavel

Infraestrutura empresarial com SLA 99,9% e suporte tecnico dedicado.

Troca instantanea

Mude apenas a URL base para ir do sandbox para producao. Mesmo codigo, mesmo contrato de API.

Sandbox

URL base

https://sandbox.roxpay.eu

✓ Mensagens simuladas  ·  ✓ Sem custo  ·  ✓ Dados de teste

Producao

URL base

https://app.roxpay.eu

✓ Mensagens reais  ·  ✓ SLA 99,9%  ·  ✓ Suporte dedicado

OpenAPI 3.0 - Swagger UI

Documentacao completa disponivel

Todos os parametros, esquemas de resposta, codigos de erro e exemplos interativos na interface Swagger.