Tutorial: Uso de API REST mediante aplicación RESTCLIENT 3.5.
ÍNDICE:
APLICACIÓN ..........................................................1
FORMATO DE CONSULTA: JSON .............................4
FORMATO DE RESPUESTA: JSON ........................... 5
RESTRICCIONES ..................................................... 6
APLICACIÓN
1) Abrir aplicación restclient-ui-3.5-jar-with-dependencies.jar (adjunto).
2) Una vez iniciada la aplicación, presionar la pestaña Method, y seleccionar POST. Luego
ingresar la dirección “https://app.relojcontrol.com/api/consultaMarcaciones/consulta”
(sin comillas).
1
3) Presionar la pestaña Body y seleccionar más abajo String Body.
4) Presionar el botón de modificación (indicado en la imagen).
5) En Content-type, seleccionar “application/json”, y en Charset “UTF-8”, luego presionar
OK.
6) Ingresar el texto de búsqueda en formato JSON. JSON es un formato de texto ligero para
el intercambio de datos (más adelante se indica el formato).
7) Presionar el botón > >.
2
8) El resultado se visualiza más abajo. Si en HTTP Response, Status aparece 200 OK, significa
que la consulta fue satisfactoria.
9) Presione Body para visualizar el resultado. El resultado se presenta en formato JSON (más
adelante se indica el formato).
3
FORMATO DE CONSULTA: JSON
Ejemplo de consulta:
{
"apiKey":"clave_api_entregada",
"inicio":"2017-03-10T00:00:00",
"termino":"2017-03-10T23:59:59"
}
{
"apiKey":"clave_api_entregada",
"inicio":"2017-03-10T00:00:00",
"termino":"2017-03-10T23:59:59",
"identificador":
["12.345.678-9",
"55.555.555-5",
"11.111.111-1"]
}
La consulta se debe realizar utilizando llaves “,“ y “-”. Cada atributo de la consulta debe ser
ingresado con comillas dobles, y separados por coma. Si se utiliza la lista (identificador) debe
ingresarse dentro de corchetes “*” y “+”. Los atributos son:
apiKey: Clave o contraseña para autorizar el envío de consultas.
inicio: Fecha de inicio de la consulta. En formato yyyy-MM-dd’T’HH:mm:ss
termino: Fecha de término de la consulta. En formato yyyy-MM-dd’T’HH:mm:ss
identificador (opcional): Si se desea consultar sólo para uno o más trabajadores, debe ingresar el
identificador RUT (DNI) de cada trabajador, utilizando comillas dobles, y separados por coma.
4
FORMATO DE RESPUESTA: JSON
Ejemplo de consulta:
{
"respuesta":0,
"marcaciones":[
{
"codigo":1,
"codigoFicha":"ABC1",
"rut":"12345678",
"nombres":"NOMBRE EJEMPLO",
"apellidos":"APELLIDO EJEMPLO",
"departamento":"DEPARTAMENTO EJEMPLO",
"sucursal":"SUCURSAL EJEMPLO",
"fechaHora":"2017-03-10T09:49:32",
"tipo":0,
"numeroReloj":1
},
{
"codigo":2,
"codigoFicha":"ABC2",
"rut":"55555555",
"nombres":"NOMBRE EJEMPLO 2",
"apellidos": "APELLIDO EJEMPLO 2",
"departamento":"DEPARTAMENTO EJEMPLO",
"sucursal":"SUCURSAL EJEMPLO 2",
"fechaHora":"2017-03-10T15:57:14",
"tipo":1,
"numeroReloj":1
}
]
}
La respuesta se visualiza inicialmente dentro de llaves “,“ y “-”. Las marcaciones se agrupan
mediante una lista representada en “*“ “+”, y la información de cada marcación se agrupa dentro
de “,“ y “-”. Los atributos son:
respuesta: Respuesta a la consulta. Los códigos de resultado son:
0: OK
-1: Error desconocido
-2: Error en el formato de fecha
-3: Error consulta
-4: Error interno
-5: API KEY no encontrada
-6: Fecha fuera de rango
-7: Demasiadas consultas
5
Marcaciones: Listado del resultado, representado en listas (*registro1+, *registro2+, ….).
Cada registro se indica entre llaves, y los atributos entregados son:
Código (número): código del trabajador, registrado en Relojcontrol.com
codigoFicha (texto): código ficha del trabajador, registrado en Relojcontrol.com
rut (texto): DNI del trabajador, registrado en Relojcontrol.com
nombres (texto): nombres del trabajador, registrado en Relojcontrol.com
apellidos (texto): apellidos del trabajador, registrado en Relojcontrol.com
departamento (texto): departamento asociado al trabajador, registrado en
Relojcontrol.com
sucursal (texto): sucursal asociada al trabajador, registrado en Relojcontrol.com
fechaHora (fecha): fecha y hora de la marcación, en formato dd-MM-yyyy’T’HH:mm:ss
tipo (número): Tipo de registro (marcación). Los valores son:
o 0: entrada
o 1: salida
o 2: salida extraordinaria
o 3: entrada extraordinaria
o 4: salida a descanso (inicio descanso)
o 5: entrada después de descanso (término descanso)
numeroReloj (número): número del reloj, registrado en Relojcontrol.com.
RESTRICCIONES.
Se debe ingresar el texto en el formato indicado.
El rango de fechas de búsqueda no debe ser mayor a 31 días.
Se puede realizar sólo una consulta por segundo.
