Especificação da API CAPTCHA JavaScript

Esta seção lista a especificação dos métodos e propriedades das APIs CAPTCHA JavaScript . Use as JavaScript APIs CAPTCHA para executar quebra-cabeças CAPTCHA personalizados em seus aplicativos cliente.

Essa API se baseia nas APIs de ameaças inteligentes, que você usa para configurar e gerenciar a aquisição e o uso de AWS WAF tokens. Consulte Especificação da API de ameaças inteligentes.

AwsWafCaptcha.renderCaptcha(container, configuration)

Apresenta um quebra-cabeça de AWS WAF CAPTCHA para o usuário final e, em caso de sucesso, atualiza o token do cliente com a validação do CAPTCHA. Ele está disponível apenas com a integração CAPTCHA. Use essa chamada junto com as APIs de ameaças inteligentes para gerenciar a recuperação de tokens e fornecer o token em suas chamadas fetch. Veja as APIs de ameaças inteligentes em Especificação da API de ameaças inteligentes.

Ao contrário do intersticial CAPTCHA que AWS WAF envia, o quebra-cabeça CAPTCHA renderizado por esse método exibe o quebra-cabeça imediatamente, sem uma tela de título inicial.

container

O objeto Element do elemento do contêiner de destino na página. Isso geralmente é recuperado chamando document.getElementById() ou document.querySelector().

Obrigatório: Sim

Tipo: Element

configuração

Um objeto contendo as configurações do CAPTCHA, da seguinte forma:

apiKey

A chave de API criptografada que habilita permissões para o domínio do cliente. Use o console do AWS WAF para gerar suas chaves de API para seus domínios de clientes. Você pode usar uma chave para até cinco domínios. Para mais informações, consulte Gerenciamento de chaves de API para a API JS CAPTCHA.

Obrigatório: Sim

Tipo: string

onSuccess: (wafToken: string) => void;

Chamado com um AWS WAF token válido quando o usuário final conclui com sucesso um quebra-cabeça de CAPTCHA. Use o token nas solicitações que você envia aos endpoints que você protege com uma AWS WAF Web ACL. O token fornece a prova e o timestamp da conclusão bem-sucedida do último quebra-cabeça.

Obrigatório: Sim

onError?: (error: CaptchaError) => void;

Chamado com um objeto de erro quando ocorre um erro durante a operação CAPTCHA.

Obrigatório: não

Definição de classe CaptchaError: o manipulador onError fornece um tipo de erro com a seguinte definição de classe.

CaptchaError extends Error {
    kind: "internal_error" | "network_error" | "token_error" | "client_error";
    statusCode?: number;
}

• kind: o tipo de erro retornado.

• statusCode: o código de status do HTTP, se disponível. Isso é usado por network_error se o erro for devido a um erro no HTTP.

onLoad?: () => void;

Chamado quando um novo quebra-cabeça CAPTCHA é carregado.

Obrigatório: não

onPuzzleTimeout?: () => void;

Chamado quando um quebra-cabeça CAPTCHA não é concluído antes de expirar.

Obrigatório: não

onPuzzleCorrect?: () => void;

Chamado quando uma resposta correta é fornecida a um quebra-cabeça CAPTCHA.

Obrigatório: não

onPuzzleIncorrect?: () => void;

Chamado quando uma resposta incorreta é fornecida a um quebra-cabeça CAPTCHA.

Obrigatório: não

defaultLocale

A localidade padrão a ser usada para o quebra-cabeça CAPTCHA. As instruções escritas para quebra-cabeças CAPTCHA estão disponíveis em árabe (ar-SA), chinês simplificado (zh-CN), holandês (nl-NL), inglês (en-US), francês (fr-FR), alemão (de-DE), italiano (it-IT), japonês (ja-JP), português do Brasil (pt-BR), espanhol (es-ES) e turco (tr-TR). As instruções de áudio estão disponíveis para todos os idiomas escritos, exceto chinês e japonês, cujos padrões são o inglês. Para alterar o idioma padrão, forneça o idioma internacional e o código de localidade, por exemplo,ar-SA.

Padrão: o idioma atualmente em uso no navegador do usuário final

Obrigatório: não

Tipo: string

disableLanguageSelector

Se definido como true, o quebra-cabeça CAPTCHA oculta o seletor de idioma.

Padrão: false

Exigido: Não

Tipo: boolean

dynamicWidth

Se definido como true, o quebra-cabeça CAPTCHA muda de largura para compatibilidade com a largura da janela do navegador.

Padrão: false

Exigido: Não

Tipo: boolean

skipTitle

Se definido como true, o quebra-cabeça CAPTCHA não exibirá o título do quebra-cabeça Resolva o quebra-cabeça.

Padrão: false

Exigido: Não

Tipo: boolean