El SDK web de la Verificación de aplicaciones de Firebase
La Verificación de aplicaciones de Firebase no funciona en un entorno de Node.js con ReCaptchaV3Provider o ReCaptchaEnterpriseProvider, pero se puede usar en Node.js si usas CustomProvider y escribes tu propio método de certificación.
Funciones
| Función | Descripción |
|---|---|
| function(app, ...) | |
| inicializalAppCheck(app, opciones) | Activa la Verificación de aplicaciones para la app correspondiente. Solo se puede llamar una vez por app. |
| function(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Solicita un token de Verificación de aplicaciones de Firebase. Este método solo se debe utilizar si necesitas autorizar solicitudes a un backend que no es de Firebase.Muestra tokens de uso limitado destinados a usarse con los extremos de backend que no son de Firebase y que están protegidos con la Protección contra la repetición. Este método no afecta el comportamiento de generación de tokens del método #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh). | Obtenga el token actual de la Verificación de aplicaciones. Si forceRefresh es falso, esta función primero busca un token válido en la memoria y, luego, la persistencia local (IndexedDB). Si no se encuentra, o si forceRefresh es verdadero, se envía una solicitud al extremo de la Verificación de aplicaciones para obtener un token nuevo. Esa solicitud se adjunta a la solicitud en tránsito más reciente, en caso de que haya una. |
| onTokenChanged(appCheckInstance, observador) | Registra un objeto de escucha a los cambios en el estado del token. Puede haber más de un objeto de escucha registrado al mismo tiempo para una o más instancias de la Verificación de aplicaciones. Los objetos de escucha vuelven a llamar en el subproceso de IU cada vez que cambia el token actual asociado con esta instancia de Verificación de aplicaciones. |
| onTokenChanged(appCheckInstance, onNext, onError, onCompletion) | Registra un objeto de escucha a los cambios en el estado del token. Puede haber más de un objeto de escucha registrado al mismo tiempo para una o más instancias de la Verificación de aplicaciones. Los objetos de escucha vuelven a llamar en el subproceso de IU cada vez que cambia el token actual asociado con esta instancia de Verificación de aplicaciones. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Configura si la Verificación de aplicaciones actualizará los tokens automáticamente según sea necesario. |
Clases
| Clase | Descripción |
|---|---|
| CustomProvider. | Clase de proveedor personalizada. |
| ReCaptchaEnterpriseProvider. | Proveedor de la Verificación de aplicaciones que puede obtener un token de reCAPTCHA Enterprise y, luego, intercambiarlo por un token de la Verificación de aplicaciones. |
| ReCaptchaV3Provider | Proveedor de la Verificación de aplicaciones que puede obtener un token de reCAPTCHA V3 y, luego, intercambiarlo por uno de la Verificación de aplicaciones. |
Interfaces
| Interfaz | Descripción |
|---|---|
| Verificación de aplicaciones | Interfaz del servicio de Verificación de aplicaciones de Firebase |
| Opciones de verificación de aplicaciones | Opciones para la inicialización de la Verificación de aplicaciones. |
| AppCheckToken | El token que muestra un proveedor de la Verificación de aplicaciones. |
| AppCheckTokenResult. | Resultado que muestra getToken(). |
| CustomProviderOptions. | Opciones cuando se crea un CustomProvider. |
Escribe alias
| Alias de tipo | Descripción |
|---|---|
| AppCheckTokenListener | Un objeto de escucha al que se llama cada vez que cambia el token de la Verificación de aplicaciones |
función(app, ...)
inicializaAppCheck(app, opciones)
Activa la Verificación de aplicaciones para la app correspondiente. Solo se puede llamar una vez por app.
Firma:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | FirebaseApp | indefinido | FirebaseApp para activar la Verificación de aplicaciones |
| opciones | Opciones de verificación de aplicaciones | Opciones de inicialización de la Verificación de aplicaciones |
Muestra:
function(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Solicita un token de Verificación de aplicaciones de Firebase. Solo debes usar este método si necesitas autorizar solicitudes a un backend que no sea de Firebase.
Muestra tokens de uso limitado diseñados para utilizarse con los extremos de backend que no son de Firebase y que están protegidos con la Protección contra la repetición. Este método no afecta el comportamiento de generación de tokens del método #getAppCheckToken().
Firma:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Instancia de appCheck | Verificación de aplicaciones | La instancia de servicio de la Verificación de aplicaciones |
Muestra:
Promesa<AppCheckTokenResult>
El token de uso limitado.
getToken(appCheckInstance, forceRefresh)
Obtenga el token actual de la Verificación de aplicaciones. Si forceRefresh es falso, esta función primero busca un token válido en la memoria y, luego, la persistencia local (IndexedDB). Si no se encuentra, o si forceRefresh es verdadero, se envía una solicitud al extremo de la Verificación de aplicaciones para obtener un token nuevo. Esa solicitud se adjunta a la solicitud en tránsito más reciente, en caso de que haya una.
Firma:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Instancia de appCheck | Verificación de aplicaciones | La instancia de servicio de la Verificación de aplicaciones |
| forzar la actualización | booleano | Si es verdadero, siempre se intentará recuperar un token nuevo. Si es falso, se usará un token almacenado en caché si lo encuentra en el almacenamiento. |
Muestra:
Promesa<AppCheckTokenResult>
onTokenChanged(appCheckInstance, observador)
Registra un objeto de escucha a los cambios en el estado del token. Puede haber más de un objeto de escucha registrado al mismo tiempo para una o más instancias de la Verificación de aplicaciones. Los objetos de escucha vuelven a llamar en el subproceso de IU cada vez que cambia el token actual asociado con esta instancia de Verificación de aplicaciones.
Firma:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Instancia de appCheck | Verificación de aplicaciones | La instancia de servicio de la Verificación de aplicaciones |
| observador | PartialObserver<AppCheckTokenResult> | Un objeto con propiedades next, error y complete Se llama a next con un AppCheckTokenResult cada vez que cambia el token. error es opcional y se llama si el objeto de escucha arroja un error (la función next). complete no está en uso, ya que la transmisión de tokens no finaliza. |
Muestra:
Una función que anula la suscripción de este objeto de escucha.
onTokenChanged(appCheckInstance, onNext, onError, onFinalización)
Registra un objeto de escucha a los cambios en el estado del token. Puede haber más de un objeto de escucha registrado al mismo tiempo para una o más instancias de la Verificación de aplicaciones. Los objetos de escucha vuelven a llamar en el subproceso de IU cada vez que cambia el token actual asociado con esta instancia de Verificación de aplicaciones.
Firma:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Instancia de appCheck | Verificación de aplicaciones | La instancia de servicio de la Verificación de aplicaciones |
| Siguiente | (tokenResult: AppCheckTokenResult) => anular | Cuando el token cambia, esta función se llama con un AppCheckTokenResult. |
| OnError | (error: Error) => anular | Opcional. Se llama si hay un error arrojado por el objeto de escucha (la función onNext). |
| onFinalización | () => anular | Actualmente no se usa, ya que la transmisión de tokens no finaliza. |
Muestra:
Una función que anula la suscripción de este objeto de escucha.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Configura si la Verificación de aplicaciones actualizará los tokens automáticamente según sea necesario.
Firma:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| Instancia de appCheck | Verificación de aplicaciones | La instancia de servicio de la Verificación de aplicaciones |
| isTokenAutoRefreshEnabled | booleano | Si es verdadero, el SDK actualiza automáticamente los tokens de la Verificación de aplicaciones según sea necesario. Esto anula cualquier valor establecido durante initializeAppCheck(). |
Muestra:
void
AppCheckTokenListener
Un objeto de escucha al que se llama cada vez que cambia el token de la Verificación de aplicaciones
Firma:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;