Documentação BotFlush | Guia de integração CAPTCHA

Início rápido

O BotFlush é integrado em três etapas: carregar o widget, renderizá-lo e verificar os tokens no servidor.

1. Carregar widget

Adicione o script do widget à página. Ele carrega de forma assíncrona e não bloqueia a renderização.

<script src="https://challenge.botflush.com/widget.js" async defer></script>

2. Adicionar contêiner

Coloque um elemento contêiner onde o CAPTCHA deve aparecer.

<div id="bf-captcha" data-sitekey="YOUR_SITE_KEY"></div>

3. Verificar no servidor

Quando o usuário completa o desafio, um token é gerado. Envie ao servidor e verifique via API.

POST https://challenge.botflush.com/api/siteverify
Content-Type: application/json

{
  "secret": "YOUR_SECRET_KEY",
  "token": "TOKEN_FROM_CLIENT"
}

API JavaScript

BotFlush.render()

BotFlush.render('bf-captcha', {
  siteKey: 'YOUR_SITE_KEY',
  callback: function(token) {
    console.log('Verified:', token);
  }
});

BotFlush.reset()

BotFlush.reset();

BotFlush.getResponse()

var token = BotFlush.getResponse();

Notas de migração

BotFlush suporta padrões familiares de widget e siteverify. Comece alterando URL do script, chaves e endpoint; teste callbacks e erros antes do rollout.

<!-- Before -->
<script src="https://legacy-captcha.example/api.js"></script>
<div class="captcha-widget" data-sitekey="LEGACY_SITE_KEY"></div>

<!-- After -->
<script src="https://challenge.botflush.com/widget.js"></script>
<div class="captcha-widget" data-sitekey="BOTFLUSH_KEY"></div>

Controles de privacidade

BotFlush foi projetado para reduzir o uso de dados, oferecer controles no nível da conta e apoiar fluxos de revisão empresariais. O console continua sendo a fonte confiável para consultar os controles de privacidade e dados disponíveis atualmente.

Modos de verificação

BotFlush oferece vários motores de desafio. Configure os permitidos por site no console.

Motor	Tipo	Descrição
Invisible Free	Segundo plano	Prova de trabalho sem interação do usuário
Visual Match	Interativo	Correspondência visual de padrões
Emoji Click	Interativo	Seleção do emoji correspondente em uma grade visual
Invisible Max	Segundo plano	Prova de trabalho acelerada por GPU

Verificação no servidor

O endpoint de verificação aceita uma solicitação POST padrão. Selecione um runtime de servidor para ver o exemplo correspondente.

const response = await fetch('https://challenge.botflush.com/api/siteverify', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    secret: process.env.BOTFLUSH_SECRET,
    token: req.body['bf-token']
  })
});

const result = await response.json();
if (!result.success) {
  return res.status(403).send('Verification failed');
}

import requests

response = requests.post('https://challenge.botflush.com/api/siteverify', json={
    'secret': BOTFLUSH_SECRET,
    'token': request.form['bf-token'],
})

if not response.json().get('success'):
    abort(403)

$payload = json_encode([
  'secret' => getenv('BOTFLUSH_SECRET'),
  'token' => $_POST['bf-token'] ?? ''
]);

$context = stream_context_create(['http' => [
  'method' => 'POST',
  'header' => 'Content-Type: application/json',
  'content' => $payload,
]]);

$response = file_get_contents('https://challenge.botflush.com/api/siteverify', false, $context);
$result = json_decode($response, true);
if (empty($result['success'])) { http_response_code(403); exit; }

payload, _ := json.Marshal(map[string]string{
    "secret": os.Getenv("BOTFLUSH_SECRET"),
    "token":  r.FormValue("bf-token"),
})

resp, err := http.Post("https://challenge.botflush.com/api/siteverify",
    "application/json", bytes.NewBuffer(payload))
if err != nil { http.Error(w, "verify failed", 502); return }
defer resp.Body.Close()

var result struct{ Success bool }
json.NewDecoder(resp.Body).Decode(&result)
if !result.Success { w.WriteHeader(http.StatusForbidden); return }

HttpClient client = HttpClient.newHttpClient();
String body = """
{
  "secret": "%s",
  "token": "%s"
}
""".formatted(System.getenv("BOTFLUSH_SECRET"), token);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://challenge.botflush.com/api/siteverify"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Map<String, Object> result = new ObjectMapper().readValue(response.body(), Map.class);
if (!Boolean.TRUE.equals(result.get("success"))) {
    throw new SecurityException("Verification failed");
}

using var client = new HttpClient();
var payload = new {
    secret = Environment.GetEnvironmentVariable("BOTFLUSH_SECRET"),
    token = Request.Form["bf-token"].ToString()
};

var response = await client.PostAsJsonAsync(
    "https://challenge.botflush.com/api/siteverify",
    payload);
var result = await response.Content.ReadFromJsonAsync<VerifyResult>();

if (result?.Success != true) {
    return Forbid();
}

Downloads

Node Inspector — extensão Chrome

Instalação: Baixe e descompacte, abra as extensões do Chrome, ative o modo de desenvolvedor e carregue a pasta descompactada.

Baixar Node Inspector (.zip)