API de información de cuenta de usuario
Obtén los datos actuales de la cuenta del usuario mediante un token de acceso.
Consulta información clave como el plan de suscripción, el estado de verificación y la configuración regional para integrarla en la lógica de tu aplicación.
Esta API está disponible a partir del plan Personal.
/api/user/v1/get
X-Access-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
No Request Parameters
{
"code": 0,
"message": "",
"result": {
"eml": "your@gmail.com",
"nm": "Tester",
"planNm": "BUSINESS",
"planExpires": "2025-12-31",
"locale": "en_US",
"timeZone": "America/New_York",
"emlVerifiedYn": "Y",
"twoAuthYn": "N",
"sinYmdt": "2025-10-08 03:36:28",
"regYmdt": "2019-08-13 12:13:01"
}
}
Response Parameters
- codeinteger
- Código de respuesta: 0 = Éxito, cualquier otro valor = Error
- messagestring
- Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje relacionado con el error.
- resultobject
- eml string
- Correo electrónico del usuario.
- nm string
- Nombre del usuario.
- planNm string
- Plan de suscripción actual.
- planExpires date
-
Fecha de vencimiento del plan.
Expira a las 00:00 según la hora estándar de Corea (UTC +09:00). - locale string
- Idioma y región de la cuenta del usuario.
- timeZone string
-
Zona horaria.
El idioma, la región y la zona horaria pueden modificarse en la página [Configuración → Perfil]. - emlVerifiedYn string
- Default:N
-
Enum:
YN
-
Estado de verificación del correo electrónico.
Y: Verificado, N: No verificado. - twoAuthYn string
- Default:N
-
Enum:
YN
-
Uso de autenticación en dos pasos.
Y: Activado, N: Desactivado. - sinYmdt datetime
- Fecha y hora del último inicio de sesión.
- regYmdt datetime
- Fecha y hora de creación de la cuenta.
Cuándo usar esta API
Utiliza esta API cuando necesites mostrar información del usuario, como el nombre o el nivel de suscripción, en el panel de tu servicio.
Resulta especialmente útil para verificar la fecha de expiración del plan (planExpires) y si la autenticación en dos factores está habilitada (twoAuthYn), lo que permite controlar el acceso a funciones o recomendar mejoras de seguridad.
Casos de uso
Los datos de respuesta pueden utilizarse en distintas partes de la lógica de tu aplicación.
- Aplicar restricciones de funciones según el plan
- Controlar el acceso según el estado de autenticación
- Adaptar la interfaz según la región o el idioma del usuario
- Solicitar verificación adicional según la configuración de 2FA
En resumen, esta API actúa como una entrada clave para definir el comportamiento del servicio.
Relación con la API de autenticación
Esta API solo puede utilizarse después de llamar a la API de autenticación.
Flujo típico:
- Llamar a la API de autenticación → obtener token
- Incluir el token → recuperar la información del usuario
En resumen:
- API de autenticación → obtener autorización de acceso
- API de consulta → utilizar los datos del usuario
Puntos clave en producción
Esta API no es solo una consulta. Es una API clave que conecta las políticas del servicio con el estado del usuario.
- Lógica de facturación basada en el plan
- Aplicación de políticas de seguridad
- Optimización de la experiencia del usuario
- Control de acceso a funcionalidades
Actúa como fuente de datos base para toda la lógica del servicio.
Aspectos a tener en cuenta
- La solicitud fallará si el token ha expirado.
- No expongas datos sensibles directamente en el cliente.
- Al usar caché, los cambios en el estado del usuario pueden no reflejarse de inmediato.
- Ten en cuenta siempre la lógica basada en el estado de verificación (
emlVerifiedYn).