Skip to content

SDK Vue

Componente Vue 3 oficial para o CAPTCHA da CaptchaLa — publicado como @captcha-la/vue.

Demonstração ao vivo

📦

demo-v1.captcha.la/vue — demonstração executável com os quatro modos de produto. Código-fonte: Captcha-La/vue-example.

Instalação

bash
npm install @captcha-la/vue
# or
yarn add @captcha-la/vue
# or
pnpm add @captcha-la/vue

Dependência de peer: vue@^3.2.0.

Início rápido

vue
<template>
  <Captchala
    app-key="your-app-key"
    product="popup"
    @success="handleSuccess"
    @error="handleError"
  />
</template>

<script setup>
import { Captchala } from '@captcha-la/vue'

function handleSuccess(result) {
  // Send result.token to your server for validation.
  console.log('pass_token:', result.token)
}

function handleError(error) {
  console.error('verification failed:', error)
}
</script>

Props

PropTipoPadrãoDescrição
appKeystringobrigatórioChave da aplicação CaptchaLa
serverTokenstring-Token de desafio emitido pelo servidor, de uso único. Obrigatório quando a aplicação tem server_token_required=true.
product'popup' | 'float' | 'embed' | 'bind''popup'Modo de exibição
actionstring'default'Identificador da action (ex.: login, register, checkout)
langstring'zh-CN'Código de idioma (zh-CN, en, ja, …)
bindTostring | HTMLElement-Seletor de elemento ou nó ao qual vincular (somente para product="bind")

Eventos

EventoPayloadDescrição
success{ token, type, action }Verificação bem-sucedida
errorerrorVerificação falhou
closeCAPTCHA fechado
readyCAPTCHA pronto

Métodos (via ref)

vue
<template>
  <Captchala ref="captchaRef" app-key="your-app-key" />
  <button @click="captchaRef?.verify()">Verify</button>
</template>

<script setup>
import { ref } from 'vue'
const captchaRef = ref()
</script>
MétodoDescrição
verify()Dispara a verificação
reset()Reinicia o estado do CAPTCHA
destroy()Destrói a instância
bindTo(selector)Vincula a um elemento (modo bind)
setLang(lang)Troca o idioma in-place

Produção: modo serverToken

Para fluxos de alto valor (login, cadastro, pagamento) recomendamos o fluxo de token emitido pelo servidor. Seu backend cunha um server_token de uso único (TTL de 5 minutos) via POST /v1/server/challenge/issue e o entrega ao navegador:

vue
<template>
  <Captchala
    v-if="serverToken"
    :server-token="serverToken"
    app-key="pk_your_public_app_key"
    action="login"
    @success="onSuccess"
  />
</template>

<script setup>
import { ref, onMounted } from 'vue'
import { Captchala } from '@captcha-la/vue'

const serverToken = ref()

onMounted(async () => {
  const r = await fetch('/api/captcha-token')   // your own backend
  serverToken.value = (await r.json()).server_token
})

function onSuccess(result) {
  console.log('pass_token:', result.token)
}
</script>

Veja a Referência da API para o contrato completo de backend.

MIT-licensed examples · CaptchaLa is operated independently