Skip to content
WPP Hub

WPP Hub — Documentacao

WPP Hub centraliza N chips WhatsApp e expoe um contrato unico (REST + Webhook HMAC) pras suas apps consumirem. Esta pagina e o ponto de entrada da documentacao tecnica.

Pra onde ir

  • Quickstart — 10min do zero ao primeiro webhook recebido. Comece aqui.
  • Conceitos — apps, chips, vinculos, eventos. Vocabulario do sistema.
  • API Reference — catalogo completo de endpoints + Swagger interativo.
  • Webhooks — contrato, HMAC, eventos, retry policy.
  • Receitas — casos de uso reais com codigo pronto.

Convencoes

  • Base URL: https://hub.gustavomaritan.com (em dev: http://localhost:3000)
  • Auth admin: Authorization: Bearer <ADMIN_API_KEY> — gerencia chips, apps, vinculos
  • Auth app: Authorization: Bearer <api_key> — gerada em POST /v1/apps, mostrada uma unica vez
  • Content-Type: application/json (UTF-8)
  • IDs: ULID (26 chars, ordenavel cronologicamente)
  • Datas: ISO-8601 UTC
  • Erros: RFC 7807 (application/problem+json) — ver Erros

Em uma linha

Terminal window
curl -X POST https://hub.gustavomaritan.com/v1/messages \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{"chip_id":"01HZTQ...", "to":"5511999998888", "type":"text", "content":{"text":"oi"}}'

Response 202 Accepted:

{ "id": "01HZ...", "status": "queued" }

A mensagem entra na fila do chip (rate limit + jitter aplicados). Apos envio, voce recebe message.status no webhook + message.received quando o destinatario responder.