Referencia del SDK
Cada opción, callback, propiedad del manejador y código de error del SDK web de Auvral.
El bundle define un solo global, window.AuvralVerification. Sin sistema de módulos, sin
imports, sin dependencias.
const auvral = new AuvralVerification();
const frame = auvral.init({ /* opciones */ });init(options)
Monta la capa de verificación y devuelve un manejador.
| Opción | Tipo | Por defecto | Descripción |
|---|---|---|---|
url | string | obligatorio | La url devuelta por POST /v1/sessions. Si falta o no se puede parsear, no se monta nada y se dispara onError({ code: "missing_url" }). |
onResult | function | ninguno | Se llama una vez, cuando hay un veredicto. No significa que la capa se cerró. |
onClose | function | ninguno | Se llama una vez, cuando la capa se desmonta. |
onError | function | ninguno | Solo errores de integración, nunca resultados de verificación. Ver Errores. |
dismissible | boolean | true | Si el SDK dibuja su propio botón de cerrar sobre la capa. |
init() nunca apila capas. Llamarlo mientras una está abierta escribe un console.warn,
dispara onError({ code: "already_open" }) y devuelve el manejador de la capa que ya
estaba.
onResult({ status, verificationId, sessionId })
| Campo | Tipo | Descripción |
|---|---|---|
status | "verified" | "rejected" | El veredicto, según lo reporta el navegador. |
verificationId | string | El id de la verificación. |
sessionId | string | El id de sesión que recibiste de POST /v1/sessions. |
"rejected" es un resultado normal, no un error.
Requiere allowedOrigins en la sesión, ver
SDK web.
El postMessage es una señal de interfaz, no una prueba
Nunca desbloquees una cuenta, apruebes un pago o cambies el estado de tu negocio a partir
de él. La verdad es el webhook o un GET del lado del servidor. Vive en el navegador, y
el usuario controla su navegador.
onClose({ reason })
reason | Significado |
|---|---|
"completed" | Tu usuario presionó el botón final en la pantalla de resultado. |
"user_dismissed" | Tu usuario cerró la capa. |
"programmatic" | Tu código llamó a frame.close(). |
Un cierre sin un onResult previo significa que tu usuario se fue antes. La sesión sigue
usable hasta que expire, así que volver a abrir la misma url retoma donde se quedó.
onError({ code, message })
Errores de integración: problemas con cómo se llamó al SDK, nunca problemas con la
verificación. Sin un manejador onError, el SDK escribe el mismo detalle con
console.error. El SDK nunca lanza excepciones hacia tu código.
El manejador
| Miembro | Tipo | Descripción |
|---|---|---|
close() | function | Desmonta la capa y dispara onClose({ reason: "programmatic" }). Llamarlo otra vez no hace nada. |
isOpen | boolean | true mientras la capa está montada. |
Después de close(), el DOM queda exactamente como estaba antes de init().
Errores
code | Causa | Solución |
|---|---|---|
missing_url | Se llamó a init() sin url, o con un valor que no es una URL válida | Revisa que tu endpoint de sesión haya devuelto data.url y que lo hayas pasado |
already_open | Se llamó a init() mientras había una capa abierta | Reutiliza el manejador devuelto, o llama a close() primero |
Estáticos
| Miembro | Tipo | Descripción |
|---|---|---|
AuvralVerification.version | string | La versión del bundle cargado. Vale la pena reportarla cuando algo se comporta mal. |
Qué toca el SDK
- El DOM: un elemento, que cubre el viewport, aislado de tus estilos.
- Nada más. Sin cookies, sin
localStorage, sin entradas en el historial.
Soporte de navegadores
Todos los navegadores actuales. Sin polyfills.