Autenticación y Ambientes

Configura el acceso a la API de Voultech obteniendo tus credenciales, seleccionando el ambiente correcto y gestionando tu sesión con Bearer Token (JWT).

Antes de comenzar

Solicita al equipo de Voultech tus credenciales de acceso: userName, password y abrAsesor.
Confirma en qué ambiente vas a operar antes de autenticarte.
Utiliza el token obtenido en SignIn en todas las solicitudes a endpoints protegidos.

Credenciales

Obtén userName, password y abrAsesor para acceder a la API.

Ambientes

Verifica si operarás en Sandbox o en Producción antes de iniciar sesión.

Sesión

Inicia sesión, renueva el token y consulta el estado de autenticación.

Obtener credenciales

Contacta al equipo de Voultech ([email protected]) para recibir:

Credencial	Descripción
`userName`	Usuario de acceso a la API
`password`	Contraseña asociada al usuario
`abrAsesor`	Código de asesor que identifica a tu fintech en el sistema

Resultado esperado: dispondrás de los datos necesarios para autenticarte y operar sobre los recursos vinculados a tu asesor.

Ambientes disponibles

Ver ambientes disponibles

Entorno	URL base
Sandbox	`https://apiwebcbvoultechcertificacion.azurewebsites.net`
Producción	Acceso coordinado directamente con el equipo de Voultech

⚠️
Las credenciales de un entorno no funcionan en el otro. Cada ambiente tiene sus propios usuarios, datos y configuraciones.

Resultado esperado: operarás en el ambiente correcto con las credenciales correspondientes.

Iniciar sesión

Envía tus credenciales para obtener un token JWT que incluirás en todas las llamadas posteriores.

→ POST /api/publicapi/shared/auth/SignIn

{
  "userName": "tu_usuario",
  "password": "tu_contraseña"
}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-10-21T18:00:00Z"
}

Incluye el token en todas las solicitudes protegidas:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Resultado esperado: obtendrás un token válido para autenticar todas las solicitudes protegidas.

🔒
No compartas tu token. Si sospechas que fue comprometido, genera uno nuevo con SignIn inmediatamente.

Renovar el token

Si el token está por expirar, puedes renovarlo sin iniciar sesión nuevamente.

→ GET /api/publicapi/shared/auth/RefreshToken

Authorization: Bearer {tu_token_actual}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-10-21T20:00:00Z"
}

Resultado esperado: extenderás la vigencia de la sesión sin volver a enviar userName y password.

💡
Si la sesión ya expiró por completo, RefreshToken no funcionará. Deberás autenticarte nuevamente con SignIn.

Consultar sesión actual

Obtén los datos del usuario autenticado y la configuración del sistema.

→ GET /api/publicapi/shared/auth/Me

Authorization: Bearer {tu_token}

Resultado esperado: obtendrás la información del usuario autenticado y la configuración disponible para la sesión actual.

Cerrar sesión

Ver opciones para cerrar sesión

Tienes dos opciones para finalizar la sesión:

Endpoint	Método	Comportamiento
`/api/publicapi/shared/auth/SignOut`	POST	Expira la cookie de autenticación
`/api/publicapi/shared/auth/Logout`	POST	Elimina la cookie de autenticación

Resultado esperado: la sesión quedará finalizada según el mecanismo implementado en tu integración.

Errores de autenticación

Ver errores frecuentes de autenticación

Código HTTP	Causa	Solución
401 Unauthorized	Token faltante, vencido o inválido	Genera un nuevo token con `SignIn`
403 Forbidden	Token válido pero sin permisos para el recurso	Verifica que tu `abrAsesor` esté vinculado al cliente/cuenta que intentas acceder

💡
La seguridad se basa en la asociación entre el token, el asesor y el recurso. No puedes consultar datos de clientes o cuentas que no estén vinculados a tu código de asesor.

Swagger interactivo

Prueba los endpoints directamente desde el navegador usando el Swagger UI del entorno Sandbox:

🔗 Abrir Swagger UI

Para autenticarte en Swagger:

Ejecuta el endpoint SignIn y copia el token de la respuesta
Haz clic en el botón Authorize (🔒) en la parte superior
Ingresa: Bearer {tu_token}
Todos los endpoints quedarán autenticados para esa sesión

Resultado esperado: podrás probar los endpoints del entorno Sandbox desde el navegador con una sesión autenticada.