Referência para Desenvolvedores

Guia de integração

Leia a referência da API em Markdown simples →

Faça login com o Google ou um código de verificação por e-mail e, em seguida, abra Painel → Chave de API. Copie a chave quando ela for exibida: apenas seu hash SHA-256 é salvo em nosso banco de dados. Usuários existentes podem vincular uma chave legada usando seu token de gerenciamento privado.

Verificação do lado do servidor

POST /api/v1/check
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "text": "Can you quote this project?",
  "email": "[email protected]"
}

As respostas incluem verdict (allow, block, review), score, reason, engine (jev ou rules), model (versão do provedor nos resultados de IA), execution_time_ms e quota_remaining. As pontuações das regras são estimativas heurísticas. A confiança está presente apenas para Jev. Trate a revisão como incerta, não como um bloqueio automático.

Códigos de status: 400 (entrada inválida), 401 (chave ausente), 403 (chave inválida), 429 (cota esgotada), 503 (serviço indisponível). Tamanho máximo da mensagem: 10,000 caracteres. Opcional business_context (até 1,000 caracteres) descreve as consultas desejadas; não inclua segredos. A falha do provedor recorre a regras heurísticas locais.

Logs de detecção e relatórios de execução

Dashboard → Detection logs mostra seus últimos 7 dias de verificações autenticadas. Selecione Uncertain — review no filtro de veredito para inspecionar resultados incertos. Este é um registro de verificações e ações relatadas, não uma caixa de entrada ou uma fila para reter ou restaurar mensagens. O site opcional (uma URL HTTP/HTTPS; apenas seu hostname é retido) e form_id (até 80 letras, números, sublinhados, dois-pontos ou hífens) identificam sua integração. O texto da mensagem está desativado por padrão e pode ser habilitado em sua conta. Verificações de demonstração pública são excluídas.

O registro bem-sucedido adiciona check_id e report_token à resposta de verificação; logging_status é saved ou unavailable. As falhas de registo não alteram a classificação. Guarde o token de relatório no seu servidor. Após aplicar a sua decisão, faça POST para /api/v1/report com a mesma chave de API:

{
  "check_id": "CHECK_UUID",
  "report_token": "TOKEN_FROM_CHECK",
  "action": "allowed",
  "reason": "verdict"
}

Valores de ação permitidos: allowed, blocked, ou error_allowed. O plugin mais recente do WordPress relata sua ação automaticamente. Apenas Observar relata permitido com motivo observe. Um relatório ausente ou com falha aparece como Não relatado; uma ação permitida não confirma a entrega do e-mail.

Para uma integração de API personalizada, a observação é uma política no código do seu próprio servidor: chame o endpoint de verificação, registre o veredito, continue seu fluxo normal de envio e informe a ação que você aplicou. A API de verificação não ativa nem desativa automaticamente o bloqueio no seu formulário. A observação ainda processa o conteúdo da mensagem e usa cota de detecção.

Assistente de navegador opcional

<form data-formshield> ... </form>
<script src="https://jevshield.com/shield.js" data-key="YOUR_API_KEY"></script>

O auxiliar verifica apenas formulários explicitamente marcados, envia campos de mensagem, email e nome, e permite a submissão após uma falha de rede ou tempo limite de 6 segundos. É contornável e expõe a chave de API aos visitantes. Use verificações do lado do servidor para aplicação e para manter a chave privada. Teste plugins de formulário AJAX antes de o ativar.

Encaminhamento de leads

Abra Dashboard → Routing para descrever seu negócio e, opcionalmente, salvar um webhook ou URL de agendamento. O contexto da conta é usado quando uma requisição não fornece seu próprio business_context. Resultados de alta intenção podem enviar detalhes de consulta e contato para o webhook configurado; use um destino que você controla e cubra esse processamento no seu aviso de privacidade.

Uma URL de agendamento configurada é retornada como meeting_url para resultados de alta intenção. Sua integração decide se deve exibi-la ou segui-la. O plugin do WordPress e integrações personalizadas podem ter comportamento diferente; verifique o fluxo completo do visitante. Um teste de webhook usa uma consulta sintética e confirma a resposta HTTP de destino, não a entrega posterior.

Abrir configurações de roteamento →

WordPress

Baixe o ZIP do plugin JevShield mais recente, instale-o no WordPress, depois abra Configurações → JevShield AI e insira sua chave de API e o endpoint HTTPS completo /api/v1/check. Em Modo de Proteção, selecione Apenas Observar para classificar e registrar sem que este plugin bloqueie. Novas instalações começam em Apenas Observar; instalações existentes configuradas mantêm o bloqueio até que você altere o modo. A observação usa cota e transmite campos de envio para processamento, então descreva isso no seu aviso de privacidade. Verifique a entrega real do seu formulário antes de mudar para Bloquear spam de alta confiança.

O JevShield também está listado no Diretório de Plugins WordPress.org. As versões do diretório podem chegar depois do ZIP aqui; se o Modo de Proteção estiver ausente, atualize usando o ZIP mais recente. O plugin legado separado FormShield mantém suas configurações existentes e caminho de atualização. Suas configurações de contexto de negócios e substituição de e-mail exato não foram adicionadas ao plugin JevShield. A API ainda aceita business_context para integrações personalizadas.