Versión afectada: BioStar 2.8.17, BioStar 2.9 o versión superior
La función de asistencia [POST] /punch_log se ha mejorado a partir de BioStar 2.8.17.
NOTA:
Para “Cómo usar la GUI Swagger para el API de TA”, consulte el siguiente enlace:
[BioStar 2 API para TA] Como usar e iniciar con el API de BioStar 2 para TA
Fondo
Permite crear registros de marcación a través de API en entornos móviles y más y registrar la información del dispositivo en el entorno (es decir, móvil). La API anterior no tenía una característica que permitiera a los usuarios establecer 'devnm' como personalizado.
Requisitos
El usuario debe poder establecer el nombre del dispositivo(devnm) como custom(string) cuando utilice TA punch_logs API.
La mejora se realizó para evitar que los registros de marcación creados por la API anterior se eliminen cuando se obligan a sincronizar.
<Se creó el registro de marcación en el informe de TA>
Cómo crear registros de marcación mediante el uso de la API de TA
[POST] /punch_logs API crea un registro perforado con la información del dispositivo.
Antes de usar cualquier API de TA, debe iniciar sesión con la función de inicio de sesión de la API de TA. Una vez que inicie sesión, su información de inicio de sesión se utilizará para todas las demás funciones de la API de TA. Esta API /punch_log hará lo mismo.
La información iniciada se utilizará para la API /punch_log, y los registros de marcación creados serán los registros de marcación del usuario que ha iniciado sesión.
Puede encontrar la API de registro /tna/Punch en su TA Swagger.
Parte 1. Crear registros de marcación
[POST]: /tna/punch_logs
[Encabezados]
*Se requieren encabezados de desplazamiento y límite.
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
Device_date_time | Cuerda | O | Fecha y hora del registro de marcación *Si no se utiliza este valor, se utilizará el valor de tiempo actual para el registro de marcación | AAAA-MM-DD HH:MM:SS |
Device_id | Cuerda | O | ID de dispositivo del registro de marcación |
|
Device_name | Cuerda | M | Nombre del dispositivo del registro de marcación |
|
Tipo | Cuerda | M | «PUNCH_TYPE_NONE» o «PUNCH_TYPE_CHECK_IN» o «PUNCH_TYPE_CHECK_OUT» o «PUNCH_TYPE_BREAK_START» o «PUNCH_TYPE_BREAK_END» o «PUNCH_TYPE_MEAL_START» o «PUNCH_TYPE_MEAL_END» |
|
* M – Obligatorio, O – Opcional
[Ejemplo de modelo de valor/parámetros]
{ "device_date_time": "2022-08-17 21:22:22", "device_id": "547835888", "device_name": "FaceStation F2 547835888 (192.168.116.159)", "tipo": "PUNCH_TYPE_CHECK_IN" } |
[Respuesta: exitosa]
{ "message": "Creado correctamente", "message_key": "CREADO", "idioma": "en", "status_code": "CREADO" } |
La respuesta anterior representa los mismos resultados que la captura de pantalla siguiente.
<Se creó el registro de marcación en el informe de TA>
Parte 2. Crear registros de marcación a través de POSTMAN
<Ejecutar la API POST /punch_log en Postman>
Parte 3. Crear registros de marcación con CURRENT DATETIME
Cuando se utiliza TA API /punch_log sin valor 'Device_date_time', el registro perforado se realizará con el valor CURRENT DATETIME. .
[Ejemplo de modelo de valor/parámetros]
{ "device_id": "547835888", "device_name": "FaceStation F2 547835888 (192.168.116.159)", "tipo": "PUNCH_TYPE_CHECK_IN" } |
[Respuesta: exitosa]
{ "message": "Creado correctamente", "message_key": "CREADO", "idioma": "en", "status_code": "CREADO" } |
<Ejecutar la API POST /punch_log sin 'Device_date_time' en Postman>
<Se utilizó el valor Current DateTime del sistema para el punchlog>