Integrações — HestiaShield Partners

Opções de integração

🔗

API REST

Endpoints RESTful com autenticação por API Key. Consulte métricas, gerencie usuários e acesse dados de golpes detectados via JSON.

⚡

Webhooks

Receba eventos em tempo real no endpoint do seu sistema. Alerta disparado, golpe confirmado, novo usuário — via HTTP POST seguro.

📦

SDK Mobile

Biblioteca Android (Kotlin) e iOS (Swift) para embed do HestiaShield dentro do seu super-app existente. Disponível via Maven + CocoaPods.

🏪

App Standalone

App white-label publicado nas lojas sob a sua conta de desenvolvedor ou da HestiaShield. Zero esforço de desenvolvimento.

API REST — Endpoints disponíveis

Base URL: https://api.hestiashield.com.br · Autenticação: X-API-Key: sua_chave

POST /lgpd/solicitacao Público

Registra solicitação de direito LGPD (acesso, exclusão, portabilidade). Retorna protocolo único.

POST /parceiros/interesse Público

Registra interesse de parceria. Dispara e-mail automático para faleconosco@hestiashield.com.br.

GET /parceiros/metricas 🔑 API Key

KPIs do parceiro: usuários ativos, golpes detectados no período, score médio de risco, top canais de golpe.

GET /parceiros/usuarios 🔑 API Key

Lista de usuários vinculados ao parceiro (anonimizados). Filtros por status, data de ativação e região.

GET /parceiros/alertas 🔑 API Key

Histórico de alertas gerados nos usuários do parceiro. Filtros por data, score e canal (WhatsApp, SMS, Telegram).

GET /health Público

Health check do servidor. Retorna status e versão da API. Ideal para monitoramento do parceiro.

Exemplo de payload — Alerta detectado

// POST para o endpoint de webhook do parceiro
// Headers: X-HestiaShield-Signature: sha256=...
{
  "event":       "alert.detected",
  "timestamp":   "2026-03-13T14:32:00-03:00",
  "partner_id":  "prt_abc123",
  "user_id":     "usr_anonimizado_xyz",
  "alert": {
    "score":       92,
    "tier":        "CRITICAL",
    "channel":     "whatsapp",
    "sender_hash": "sha256:a1b2c3...",
    "layers_hit":  ["IDENTITY", "FINANCIAL", "URGENCY"],
    "angel_notified": true,
    "action_taken": "full_screen_alert"
  },
  "region":      "SP"
}

Eventos de Webhook disponíveis

Evento	Quando dispara	Planos
alert.detected	Golpe detectado com score ≥ 30	Business, Enterprise
alert.critical	Golpe com score ≥ 90 (CRITICAL)	Business, Enterprise
user.activated	Novo usuário ativa o app do parceiro	Business, Enterprise
user.angel_linked	Familiar Anjo vinculado ao idoso	Enterprise
alert.confirmed_scam	Usuário confirma que era um golpe	Business, Enterprise
user.deactivated	Usuário remove o app ou cancela	Enterprise
health.warning	Usuário sem atividade por 7+ dias	Enterprise

Autenticação e segurança

🔑

API Key

Chave única por parceiro, gerada no onboarding. Enviada no header X-API-Key. Rotação disponível a qualquer momento.

🔏

Webhook Signature

Cada webhook enviado inclui header X-HestiaShield-Signature com HMAC-SHA256 do payload. Verifique a assinatura antes de processar.

🌐

TLS obrigatório

Toda comunicação usa TLS 1.3. Webhooks são enviados apenas para endpoints HTTPS com certificado válido.

Pronto para integrar?

Solicite acesso ao ambiente de sandbox, credenciais de teste e documentação completa da API.

Solicitar acesso sandbox →

Integrações Técnicas