Skip to main content

Access

Todo lo que Acceso Inteligente tiene para ofrecer pero a nivel de API, dando la flexibilidad de codificar una solución personalizada basada en las necesidades de tu empresa.

Resumen​

La API de Acceso proporciona acceso programático a toda la funcionalidad de Acceso Inteligente, permitiéndote construir flujos de autenticación personalizados que se integren perfectamente con tus sistemas existentes. Esta solución es perfecta para empresas que necesitan más control sobre la experiencia del usuario o quieren integrar autenticación en sus aplicaciones existentes.

Guía de Inicio Rápido​

Empecemos diciendo que el camino óptimo es: Configurar todo en nuestra aplicación web (usando nuestra UI para guardar todo lo relacionado con la configuración ya que no hay necesidad de guardar todo vía API). Si aún quieres seguir todo vía API, listaré todos los endpoints que necesitan ser llamados para configurarlo manualmente o cambiar la información vía API también.

Pasos de Configuración​

1. Crear un Proyecto

Comienza creando un nuevo proyecto en la plataforma Verifik para organizar tus flujos de autenticación.

Crear Proyecto

2. Crear un Flujo de Proyecto

Define el flujo de autenticación con type = "login" para tu proyecto.

Crear Flujo

3. Configurar Métodos de Inicio de Sesión

Configura los métodos de autenticación que quieres soportar.

Configurar Métodos

4. Conexión de Base de Datos

Conecta tu base de datos de usuarios existente al sistema de autenticación.

Conectar BD

5. Configurar Webhooks

Configura webhooks para recibir notificaciones en tiempo real para eventos de autenticación.

Configurar Webhooks

Métodos de Autenticación​

Elige entre tres métodos de autenticación poderosos, cada uno con soporte API integral:

📧 Acceso por Correo

Envía y verifica códigos OTP vía correo electrónico para autenticación segura.

Ver Ejemplo

📱 Acceso por Teléfono

Envía y verifica códigos OTP vía SMS y WhatsApp.

Ver Ejemplo

👤 Acceso Biométrico

Reconocimiento facial y detección de vida para autenticación segura.

Ver Ejemplo

Referencia de API​

Autenticación​

Todas las solicitudes de API requieren un token JWT válido. Incluye el token en el header de Authorization:

Authorization: Bearer <your_jwt_token>

URL Base​

https://api.verifik.co/v2/access

Ejemplo de Acceso por Correo​

Configuración​

Si no has creado un proyecto y un projectFlow con la propiedad type = login, entonces aquí están los enlaces para eso:

Empecemos​

El flujo principalmente comienza con la creación de la validación de correo electrónico, luego procedemos con la validación de esa validación de correo electrónico que tiene una condición de tiempo y también ingresando la contraseña de un solo uso que pertenece a esa validación de correo electrónico.

Paso 1: Crear Validación de Correo​

POST /email/send-otp
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "email": "user@example.com",
  "project_id": "your_project_id"
}

Paso 2: Validar OTP de Correo​

POST /email/verify-otp
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "email": "user@example.com",
  "otp": "123456",
  "validation_id": "validation_id_from_step_1"
}

Video Tutorial​

Endpoints de API​

Ejemplo de Acceso por Teléfono​

Configuración​

Si no has creado un proyecto y un projectFlow con la propiedad type = login, entonces aquí están los enlaces para eso:

Empecemos​

El flujo principalmente comienza con la creación de la validación de teléfono, luego procedemos con la validación de esa validación de teléfono que tiene una condición de tiempo y también ingresando la contraseña de un solo uso que pertenece a esa validación de teléfono.

Paso 1: Crear Validación de Teléfono (SMS)​

POST /phone/send-sms
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "phone": "+1234567890",
  "project_id": "your_project_id"
}

Paso 2: Crear Validación de Teléfono (WhatsApp)​

POST /phone/send-whatsapp
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "phone": "+1234567890",
  "project_id": "your_project_id"
}

Paso 3: Validar OTP de Teléfono​

POST /phone/verify-otp
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "phone": "+1234567890",
  "otp": "123456",
  "validation_id": "validation_id_from_step_1_or_2"
}

Video Tutorial​

Endpoints de API​

Ejemplo de Acceso Biométrico​

Configuración​

Si no has creado un proyecto y un projectFlow con la propiedad type = login, entonces aquí están los enlaces para eso:

Empecemos​

El flujo principalmente comienza con la creación de la validación biométrica, luego procedemos con la validación de esa validación biométrica que tiene una condición de tiempo y también ingresando el token JWT en los headers > Authorization una vez que la Validación Biométrica es creada para autorizar la validación.

Paso 1: Registrar Rostro​

POST /biometric/register-face
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "user_id": "user123",
  "project_id": "your_project_id",
  "face_image": "base64_encoded_image"
}

Paso 2: Verificar Rostro​

POST /biometric/verify-face
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "user_id": "user123",
  "face_image": "base64_encoded_image",
  "validation_id": "validation_id_from_step_1"
}

Paso 3: Verificación de Vida​

POST /biometric/liveness-check
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
  "face_image": "base64_encoded_image",
  "validation_id": "validation_id_from_step_1"
}

Video Tutorial​

Endpoints de API​

Formato de Respuesta​

Todas las respuestas de API siguen un formato consistente:

Respuesta de Éxito​

{
  "success": true,
  "data": {
    "validation_id": "val_123456789",
    "expires_at": "2024-01-01T12:00:00Z",
    "status": "pending"
  },
  "message": "Operación completada exitosamente"
}

Respuesta de Error​

{
  "success": false,
  "error": "Código OTP inválido",
  "code": "INVALID_OTP",
  "details": {
    "attempts_remaining": 2
  }
}

Límites de Velocidad​

  • OTP de Correo: 5 solicitudes por minuto por correo electrónico
  • OTP de Teléfono: 3 solicitudes por minuto por número de teléfono
  • Biométrico: 10 solicitudes por minuto por usuario

Características de Seguridad​

  • Autenticación de Token JWT: Acceso seguro a API con tokens de tiempo limitado
  • Limitación de Velocidad: Protección contra ataques de fuerza bruta
  • Expiración de OTP: Contraseñas de un solo uso de tiempo limitado
  • Detección de Vida: Previene ataques de suplantación en autenticación biométrica
  • Notificaciones de Webhook: Monitoreo de eventos de seguridad en tiempo real

Mejores Prácticas​

  1. Siempre valida respuestas: Verifica el campo success antes de procesar datos
  2. Maneja errores elegantemente: Implementa manejo de errores apropiado para todas las llamadas de API
  3. Almacena tokens de forma segura: Nunca expongas tokens JWT en código del lado del cliente
  4. Implementa lógica de reintento: Maneja fallas temporales con retroceso exponencial
  5. Monitorea límites de velocidad: Rastrea el uso de API para evitar alcanzar límites de velocidad

Soporte​

Para soporte técnico y documentación de API, contacta a nuestro equipo de soporte o visita nuestro portal de desarrolladores.

Consejo Pro

Comienza con la configuración de la aplicación web para la implementación más rápida, luego usa la API para integraciones personalizadas y características avanzadas.

Aviso de Seguridad

Siempre usa HTTPS en producción y nunca expongas credenciales sensibles en código del lado del cliente.