Skip to content

API Reference

Catalogo completo dos endpoints REST. Para schemas detalhados (request/response com tipos), use o Swagger interativo em /docs/swagger — gerado automaticamente dos schemas Zod.

Convencoes

  • Base URL: https://hub.gustavomaritan.com
  • Auth admin: Authorization: Bearer ADMIN_KEY
  • Auth app: Authorization: Bearer APP_API_KEY
  • Content-Type: application/json
  • Erros: RFC 7807 (application/problem+json)

Por dominio

DominioQuem usaPagina
ChipsadminChips
AppsadminApps
MensagensappMensagens
MidiaappMidia
ContatosadminContatos
Webhook deliveriesadminWebhook deliveries
Push devices (mobile)adminPush devices
Audit & eventsadminAudit
ErrostodosErros (RFC 7807)

Status do recurso

RecursoAuthQuando usar
POST /v1/chipsadmincriar + iniciar pareamento
GET /v1/chipsadminlistar todos
GET /v1/chips/:idadmindetalhe
GET /v1/chips/:id/qradminbase64 PNG do QR (TTL 60s)
POST /v1/chips/:id/pair-codeadmincodigo XXXX-XXXX pra parear no proprio celular
POST /v1/chips/:id/reconnectadminreabre socket reusando sessao
POST /v1/chips/:id/repairadminapaga sessao + gera novo QR (preserva chip e historico)
DELETE /v1/chips/:idadminlogout + apaga chip do DB
POST /v1/appsadmincria app + retorna api_key uma vez
GET /v1/apps, /:id, /:id/accessesadminlistar/detalhar
PATCH /v1/apps/:idadminatualiza webhook_url + audita
DELETE /v1/apps/:idadminsoft delete
POST /v1/app-chip-accessadmingrant (upsert)
DELETE /v1/app-chip-access/:appId/:chipIdadminrevoke
POST /v1/messagesappenfileira envio (text, image, audio, document, location, reaction)
GET /v1/messages/:idappstatus + content
GET /v1/media/:idappstream da midia recebida
GET /v1/chips/:chipId/contactsadminlista contatos do chip (paginado + search)
GET /v1/chips/:chipId/contacts/:jidadmindetalhe
GET /v1/chips/:chipId/contacts/:jid/photoadminstream da foto (lazy fetch + cache MinIO)
GET /v1/webhook-deliveriesadminlista entregas com filtros
GET /v1/webhook-deliveries/:idadminmetadados
GET /v1/webhook-deliveries/:id/payloadadminpayload + signature (debug)
POST /v1/webhook-deliveries/:id/replayadminreset + reenfileira
POST /v1/push/devicesadminregistra device pra push (mobile)
GET, PATCH, DELETE /v1/push/devices/...adminCRUD device
POST /v1/push/devices/:id/testadmindispara push de teste
GET /v1/audit-eventsadmintrilha de auditoria com filtros + cursor
GET /v1/audit-events.csvadminexport CSV
GET /v1/chip-events/:chipIdadminhistorico do chip (open/close/qr/etc)
GET /v1/admin/meadminidentidade da admin key atual
GET /v1/admin/dashboardadminsumario JSON pro dashboard
GET /v1/admin/messagesadminbusca paginada multi-app
GET /v1/admin/users + CRUDadmingerencia admins

Health & metrics

EndpointAuthDescricao
GET /healthnaobasico (uptime)
GET /health/readynaodependencias (Postgres + Redis + MinIO)
GET /metricsnao (interno)Prometheus exposition format
GET /docsnaoSwagger UI interativo
GET /docs/jsonnaoOpenAPI 3 spec