O SDK da Web do Firebase App Check
O Firebase App Check não funciona em um ambiente Node.js que usa ReCaptchaV3Provider ou ReCaptchaEnterpriseProvider, mas pode ser usado em Node.js se você usar CustomProvider e gravar seu próprio método de atestado.
Funções
| Função | Descrição |
|---|---|
| function(app, ...) (link em inglês) | |
| inicializarAppCheck(app, opções) | Ativa o App Check no app especificado. Só pode ser chamado uma vez por app. |
| function(appCheckInstance, ...) | |
| getLimitUseToken(appCheckInstance) | Solicita um token do Firebase App Check. Use esse método apenas se precisar autorizar solicitações para um back-end que não seja do Firebase.Retorna tokens de uso limitado destinados ao uso com seus endpoints de back-end que não são do Firebase e que estão protegidos com a Proteção contra repetição. Esse método não afeta o comportamento de geração de tokens do método #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh) | Consiga o token atual do App Check. Se forceRefresh for falso, essa função vai verificar primeiro se há um token válido na memória e depois a persistência local (IndexedDB). Se não for encontrado, ou se forceRefresh for verdadeiro, ele solicitará um novo token ao endpoint do App Check. Essa solicitação será anexada à solicitação em andamento mais recente, se houver uma. |
| onTokenChanged(appCheckInstance, observador) (em inglês) | Registra um listener para alterações no estado do token. Pode haver mais de um listener registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os listeners retornam na linha de execução de interface sempre que o token atual associado a essa instância do App Check mudar. |
| onTokenChanged(appCheckInstance, onNext, onError, onCompleted) | Registra um listener para alterações no estado do token. Pode haver mais de um listener registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os listeners retornam na linha de execução de interface sempre que o token atual associado a essa instância do App Check mudar. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Defina se o App Check vai atualizar os tokens automaticamente conforme necessário. |
Classes
| Turma | Descrição |
|---|---|
| CustomProvider (em inglês) | Classe de provedor personalizado. |
| ReCaptchaEnterpriseProvider (em inglês) | Provedor do App Check que pode receber um token do reCAPTCHA Enterprise e trocá-lo por um token do App Check. |
| ReCaptchaV3Provider (em inglês) | Provedor do App Check que pode receber um token reCAPTCHA V3 e trocá-lo por um token do App Check. |
Interfaces
| Interface | Descrição |
|---|---|
| AppCheck (em inglês) | A interface de serviço do Firebase App Check. |
| AppCheckOptions (em inglês) | Opções para inicialização do App Check. |
| AppCheckToken (em inglês) | O token retornado de um provedor do App Check. |
| AppCheckTokenResult (em inglês) | Resultado retornado por getToken(). |
| CustomProviderOptions (em inglês) | Opções ao criar um CustomProvider. |
Aliases de tipos
| Alias de tipo | Descrição |
|---|---|
| AppCheckTokenListener (em inglês) | Um listener que é chamado sempre que o token do App Check muda. |
function(app, ...)
inicializeAppCheck(app, options)
Ativa o App Check no app especificado. Só pode ser chamado uma vez por app.
Assinatura:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | FirebaseApp | indefinido | FirebaseApp para ativar o App Check em |
| options | AppCheckOptions (em inglês) | Opções de inicialização do App Check |
Retorna:
AppCheck (em inglês)
function(appCheckInstance, ...)
getLimitUseToken(appCheckInstance)
Solicita um token do Firebase App Check. Use o método apenas se for necessário autorizar solicitações para um back-end que não seja do Firebase.
Retorna tokens de uso limitado destinados ao uso com endpoints de back-end que não são do Firebase e que são protegidos com a Proteção contra repetição. Esse método não afeta o comportamento de geração de tokens do método #getAppCheckToken().
Assinatura:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck (em inglês) | A instância de serviço do App Check. |
Retorna:
Promessa<AppCheckTokenResult>
O token de uso limitado.
getToken(appCheckInstance, forceRefresh)
Consiga o token atual do App Check. Se forceRefresh for falso, essa função vai verificar primeiro se há um token válido na memória e depois a persistência local (IndexedDB). Se não for encontrado, ou se forceRefresh for verdadeiro, ele solicitará um novo token ao endpoint do App Check. Essa solicitação será anexada à solicitação em andamento mais recente, se houver uma.
Assinatura:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck (em inglês) | A instância de serviço do App Check. |
| forceRefresh | booleano | Se verdadeiro, sempre tentará buscar um novo token. Se falso, usará um token em cache, se encontrado no armazenamento. |
Retorna:
Promessa<AppCheckTokenResult>
onTokenChanged(appCheckInstance, observador)
Registra um listener para alterações no estado do token. Pode haver mais de um listener registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os listeners retornam na linha de execução de interface sempre que o token atual associado a essa instância do App Check mudar.
Assinatura:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck (em inglês) | A instância de serviço do App Check. |
| observador | ParcialObserver<AppCheckTokenResult> | Um objeto com as propriedades next, error e complete. next é chamado com um AppCheckTokenResult sempre que o token muda. error é opcional e é chamado se um erro for gerado pelo listener (a função next). complete não é usado, porque o fluxo de token é contínuo. |
Retorna:
Uma função que cancela a inscrição desse listener.
onTokenChanged(appCheckInstance, onNext, onError, onAutocomplete)
Registra um listener para alterações no estado do token. Pode haver mais de um listener registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os listeners retornam na linha de execução de interface sempre que o token atual associado a essa instância do App Check mudar.
Assinatura:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck (em inglês) | A instância de serviço do App Check. |
| onNext | (tokenResult: AppCheckTokenResult) => anular | Quando o token muda, essa função é chamada com um AppCheckTokenResult. |
| OnError | (erro: Erro) => anular | Opcional. Chamado se houver um erro gerado pelo listener (a função onNext). |
| oncomplete | () => anular | Não usado no momento, porque o fluxo de token não termina. |
Retorna:
Uma função que cancela a inscrição desse listener.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Defina se o App Check vai atualizar os tokens automaticamente conforme necessário.
Assinatura:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck (em inglês) | A instância de serviço do App Check. |
| isTokenAutoRefreshEnabled | booleano | Se verdadeiro, o SDK vai atualizar automaticamente os tokens do App Check conforme necessário. Isso substitui qualquer valor definido durante initializeAppCheck(). |
Retorna:
void
AppCheckTokenListener
Um listener que é chamado sempre que o token do App Check muda.
Assinatura:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;