VTToken API
Con esta integración puedes generar de forma segura una contraseña de un solo uso (OTP). Obtiene un resumen de la contraseña creada y lo guarda en un repositorio. El resumen se puede utilizar para validar la contraseña.
VTToken también usa información para crear el token del software que debe protegerse. Esto se logra al encriptar los datos sensibles y guardarlos en un repositorio.
VTToken está siempre integrado en todas las apps.
Nota
Es posible que la integración descrita en este artículo no esté implementada en tu ambiente ni esté habilitada para todos tus clientes. Contacta a tu administrador de sistema para recibir ayuda.
Ficha técnica
API ID | 105 |
Código de la API | VTTOKEN |
Versión de la Call API | 1 |
Objetivo | Contraseña con token que asegura las OTP |
Clasificación | Seguridad |
Disponible para | Android, iOS, HarmonyOS |
Usa la integración VTToken API en Studio
Las siguientes funciones están disponibles para que las uses en tus procesos legacy y también puedes usarlas como bloques en los procesos lambda. Haz clic en cada función para obtener más detalles.
Establece una contraseña. | |
Activa un VT Token. | |
Genera una contraseña de un solo uso (OTP). | |
Valida una contraseña. | |
Actualiza un valor de inicialización. | |
Ejecuta una verificación de redundancia cíclica (CRC). | |
Cambia la contraseña de VT Token. | |
Valida la contraseña de un solo uso (OTP). | |
Inicializa la sincronización sin conexión. |
Set Password
Esta función establece una contraseña.
Configuración del parámetro
Esta función requiere que establezcas parámetros de entrada para la contraseña que se va a crear. Consulta Registros de entrada para obtener más información al respecto.
ID de la función
Registro | Valor |
|---|---|
110 | 1 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
114 | Nueva contraseña | Sí | <<NEWPASSWORD>> |
115 | Confirmación de la nueva contraseña | Sí | <<NEWPASSCONFIRM>> |
145 | Seguridad de la contraseña | No | <<PASSSTRENGHT>> |
146 | Complejidad de la contraseña | No | <<PASSWEIGHT>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||
113 | Password | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. | ||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". |
Activate VT Token
Esta función activa el VT Token.
Configuración del parámetro
Esta función requiere algunos parámetros de entrada obligatorios, como el valor de inicialización del token y el número de serie. Lee Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 2 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
116 | Número de serie del token | Sí | <<SERIALNUMBER>> |
117 | Valor de inicialización del token | Sí | <<TOKENSEED>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||
113 | Password | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. | ||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". | ||||||||||
206 | Tokens activados | Se configura "1" como valor si el proceso se ejecuta correctamente. |
Generate OTP
Esta función genera la contraseña de un solo uso (OTP).
Configuración del parámetro
Esta función no requiere que completes ningún parámetro de entrada obligatorio, pero hay una lista de parámetros opcionales. Lee Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 3 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
118 | Desafío | No | <<CHALLENGE>> |
121 | Pin | No | <<PIN>> |
122 | Datos de la sesión | No | <<SESSIONDATA>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
141 | Validación del CRC | No | <<CRCVALIDATION>> |
142 | Transformar datos de la sesión | No | <<TRANSFORMSESSIONDATA>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||
113 | Contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. | ||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". | ||||||||||
119 | Paquete OCRA | <<OCRASUITE>> | ||||||||||
123 | OTP | <<OTP>> | ||||||||||
211 | Sincronización de datos sin conexión | <<TOKEN DATA OFFLINE SYNCHRO>> si se realiza correctamente. |
Validate Password
Con esta función puedes validar una contraseña.
Configuración del parámetro
Esta función requiere que establezcas parámetros de entrada para la contraseña que se va a crear. Consulta la sección Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 4 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
113 | Contraseña | Sí | <<PASSWORD>> |
126 | Intentos máximos | No | <<TOKEN_MAX_PASSWORD_RETRIES>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". | ||||||||||
208 | Intentos restantes para abrir el repositorio | <<REMAINING TRIES TO OPEN REPOSITORY>> si se ejecuta correctamente. | ||||||||||
209 | Intentos denegados para abrir el repositorio | <<TRIES DENIED TO OPEN REPOSITORY>> si se ejecuta correctamente. |
Update Seed
Esta función actualiza el valor de inicialización del token.
Configuración del parámetro
Para ejecutarse correctamente, esta función requiere que completes el valor de inicialización del token y el número de serie. Consulta la sección Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 5 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
116 | Número de serie del token | Sí | <<SERIALNUMBER>> |
117 | Valor de inicialización del token | Sí | <<TOKENSEED>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||
113 | Contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. | ||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". | ||||||||||
206 | Tokens activados | Si se ejecuta correctamente, el valor se establece en "1". |
Verify CRC
Con esta función puedes realizar la verificación de redundancia cíclica (CRC).
Configuración del parámetro
Esta función requiere que completes el parámetro de desafío. Consulta la sección Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 6 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
118 | Desafío | Sí | <<CHALLENGE>> |
Registros de salida
Registro | Descripción | Valor | ||||
|---|---|---|---|---|---|---|
112 | Resultado de la Call |
|
Change Password
Con esta función puedes cambiar la contraseña de VT Token.
Configuración del parámetro
Esta función requiere que completes los parámetros de la contraseña, la nueva contraseña y de la opción para confirmar la contraseña. Consulta la sección Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 7 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
113 | Contraseña | Sí | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. |
114 | Nueva contraseña | Sí | <<NEWPASSWORD>> |
115 | Confirmación de la nueva contraseña | Sí | <<NEWPASSCONFIRM>> |
145 | Seguridad de la contraseña | No | <<PASSSTRENGHT>> |
146 | Complejidad de la contraseña | No | <<PASSWEIGHT>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". |
Validate OTP
Con esta función puedes validar la contraseña de un solo uso (OTP).
Configuración del parámetro
Esta función requiere que completes la OTP que se validará. Consulta la sección Registros de entrada para obtener más información.
ID de la función
Registro | Valor |
|---|---|
110 | 8 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
123 | OTP | Sí | <<OTP TO VALIDATE>> |
118 | Desafío | No | <<CHALLENGE>> |
121 | Pin | No | <<PIN>> |
122 | Datos de la sesión | No | <<SESSIONDATA>> |
128 | Limitación de avance | No | <<TOKEN_VALIDATION_FORWARD_THROTTLE>> |
141 | Validación del CRC | No | <<CRCVALIDATION>> |
142 | Transformar datos de la sesión | No | <<TRANSFORM SESSION DATA>> |
143 | Intervalo izquierdo de TOPT | No | <<TOKEN_TOTP_LEFT_INTERVAL>> |
144 | Intervalo derecho de TOPT | No | <<TOKEN_TOTP_RIGHT_INTERVAL>> |
125 | Indicador para borrar la contraseña | No | <<CLEAR_PASSWORD>> |
Registros de salida
Registro | Descripción | Valor | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||
113 | Password | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (113) se borra. | ||||||||||||||||
119 | Paquete OCRA | <<OCRASUITE>> | ||||||||||||||||
205 | Indicador de la configuración de la contraseña | Tras ejecutar la función, se verifica el token 125 (CLEAR PASSWORD). Si configuraste "1" como valor, este token (205) se configura con el valor "1". | ||||||||||||||||
210 | Contador de validación negativa | <<TOKEN_NEGATIVE_VALIDATION_COUNTER>> |
Offline Synchronization
Esta función inicializa la sincronización sin conexión
Configuración del parámetro
Esta función no requiere la configuración de ningún parámetro.
ID de la función
Registro | Valor |
|---|---|
110 | 9 |
Registros de salida
Registro | Descripción | Valor | ||
|---|---|---|---|---|
112 | Resultado de la Call |
| ||
211 | Sincronización de datos sin conexión | <<TOKEN DATA OFFLINE SYNCHRO>> |