SDK Electron

O SDK Electron roda inteiramente no main process, abrindo uma janela nativa de CAPTCHA gerenciada pelo SO. O renderer nunca toca na verificação — mantenha assim por segurança.

Demonstração no GitHub

📦

Captcha-La/electron-demo — exemplo executável completo com cada passo de integração.

Instalação

npm install @captchala/electron

O pacote tem como alvo Electron 28+ (a demo fixa ^33.0.0) e Node 18+. Execute a demo de ponta a ponta com:

npm install
npm start

Início rápido

// main.js (Electron main process — never the renderer)
const { app, BrowserWindow, ipcMain } = require('electron');
const path = require('path');
const { CaptchalaClient } = require('@captchala/electron');

let currentClient = null;

ipcMain.handle('verify', async (event, opts) => {
  // 1. Fetch a one-shot server_token from YOUR backend.
  const serverToken = await fetchServerTokenFromYourBackend(opts.action);

  // 2. Tear down any prior client, then build a fresh one.
  if (currentClient) { currentClient.destroy(); currentClient = null; }
  currentClient = new CaptchalaClient({
    appKey: 'YOUR_APP_KEY',
    serverToken,
    action: opts.action,        // 'login' | 'register' | 'pay' | …
    lang:   opts.lang,          // 'en' | 'zh-CN' | 'ja' | …
    theme:  opts.theme,         // 'light' | 'dark'
    timeoutMs: 15000,
    retryCount: 3,
    onReady: () => event.sender.send('captcha-status', 'ready'),
    onFail:  (e) => event.sender.send('captcha-status', `recoverable: ${e.code}`),
  });

  try {
    const result = await currentClient.verify();
    // Send result.passToken to YOUR backend for validation.
    return { success: true, passToken: result.passToken };
  } catch (err) {
    return { success: false, error: err.message };
  } finally {
    if (currentClient) { currentClient.destroy(); currentClient = null; }
  }
});

function createWindow() {
  const win = new BrowserWindow({
    width: 520, height: 640, resizable: false,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
      nodeIntegration: false,
    },
  });
  win.loadFile('index.html');
}

app.whenReady().then(createWindow);
app.on('window-all-closed', () => app.quit());

// preload.js — bridge the renderer to the main-process verify().
const { contextBridge, ipcRenderer } = require('electron');

contextBridge.exposeInMainWorld('captchala', {
  verify:   (opts)     => ipcRenderer.invoke('verify', opts),
  onStatus: (callback) => ipcRenderer.on('captcha-status', (_, msg) => callback(msg)),
});

Superfície da API

Símbolo	Função
new CaptchalaClient({...})	Constrói um cliente de uso único. Passe appKey, serverToken, action, lang, theme, timeoutMs, retryCount e os event handlers.
await client.verify()	Abre a janela nativa do CAPTCHA. Resolve com um resultado em caso de sucesso, rejeita em erros graves.
onReady / onFail	Handlers opcionais passados no construtor. onFail é para falhas recuperáveis (o SDK fará retry).
result.passToken	O token a validar no seu backend. Sempre opaco para o cliente.
client.destroy()	Fecha a janela e libera recursos. Sempre chame quando terminar de usar uma instância.
CaptchalaClient.version()	Helper estático que retorna a string de versão do SDK. Útil em overlays de suporte / debug.

Validação no servidor

Encaminhe result.passToken (ou result.token) ao seu backend e valide-o contra a API da CaptchaLa. Nunca exponha X-App-Secret em código de cliente.

POST https://apiv1.captcha.la/v1/validate
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET
Content-Type: application/json

{ "pass_token": "<result.passToken>", "client_ip": "<end-user IP>" }

Veja a Referência da API para o endpoint completo de validação e o fluxo X-App-Key / X-App-Secret.

Solução de problemas

• Não importe o SDK no renderer
  @captchala/electron é apenas main-process. Exponha o resultado via contextBridge + ipcRenderer.invoke() como faz a preload.js da demo. Mantenha nodeIntegration: false e contextIsolation: true.

• Módulo não encontrado em runtime
  @captchala/electron é uma dependência regular, não devDependency — precisa ser empacotada no app final. Bundlers como electron-builder a incluem automaticamente.

• A janela abre atrás da sua janela principal
  É uma peculiaridade de Linux/X11. Passe parent na sua própria BrowserWindow se você envolver a janela do CAPTCHA, ou chame mainWindow.focus() depois que verify() retornar.

• Electron 28+ obrigatório
  A demo declara electron: ^33.0.0. Versões mais antigas do Electron podem faltar APIs das quais o SDK depende; fixe em 28+ e Node 18+.

Requisitos

• Electron 28+ (a demo usa 33.x)
• Node 18+
• Multiplataforma: macOS, Windows 10 1809+, Linux (X11 / Wayland)