API ejornada

WS Gestión de jornadas

Parámetros de entrada
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
private_key Varchar (255) Sí
token Varchar (255) No
cif_desarrollador Varchar(255) Sí
cif_cliente Varchar (255) Sí
nombre_cliente Varchar (255) Sí
email_cliente Varchar (255) Sí
direccion_cliente Varchar (255) Sí
provincia_cliente Varchar (255) Sí
poblacion_cliente Varchar (255) Sí
origen_cliente Varchar (255) No
fecha_baja Date No
avanzado Int (1) No
vacaciones_dias Int (1) No
vacaciones_tipo Enum ("N","L") N = Días Naturales; L = Días Laborables No
sociedades Estructura JSON formada por los campos mostrados a continuación No
Array con el número de sociedades, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
nombre Varchar (255) Sí
cif Varchar (255) Sí
domicilio_social Varchar (255) Sí
guardar_localizacion Int (1) No
guardar_hora Int (1) No
modificar_hora Int (1) No
aviso_fin_jornada Int (1) No
terminal_corporativo Int (1) No
proponer_hora_salida Int (1) No
centros_trabajo Estructura JSON formada por los campos mostrados a continuación No
Array con el número de centros de trabajo, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
nombre Varchar (255) Sí
localidad Varchar (255) No
provincia Varchar (255) Sí
lat Int (11) No
lng Int (11) No
tipo_via Varchar (255) Sí
calle Varchar (255) Sí
numero Varchar (255) No
codigo_postal Varchar (255) No
cif_sociedad Varchar (255) Sí
guardar_localizacion Int (1) No
guardar_hora Int (1) No
modificar_hora Int (1) No
aviso_fin_jornada Int (1) No
terminal_corporativo Int (1) No
proponer_hora_salida Int (1) No
trabajadores Estructura JSON formada por los campos mostrados a continuación No
Array con el número de trabajadores, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
nombre_usuario Varchar (255) Sí
apellido1 Varchar (255) Sí
apellido2 Varchar (255) Sí
nif_usuario Varchar (255) Sí
email_usuario Varchar (255) Sí
telefono_usuario Varchar (255) No
direccion_usuario Varchar (255) No
numero_usuario Varchar (255) No
provincia_usuario Varchar (255) No
municipio_usuario Varchar (255) No
codigo_postal_usuario Varchar (255) No
cif_sociedad Varchar (255) Sí
fecha_alta Date Sí
fecha_baja Date No
horario Estructura JSON formada por los campos mostrados a continuación No
Array con el número de horarios, de los que se solicitarán los siguientes datos.
Importante: Si se le añade estructura de horarios de un trabajador, reemplazarán los horarios que coincidan en mismos rangos de fechas.
Nombre del campo Tipo de dato Obligatorio
nombre Varchar(255) Si
diario Indica si el horario es diario. 1 = Si, 0 = No No
fecha_inicio Date Si
fecha_fin Date Si
turnos Estructura JSON formada por los campos mostrados a continuación No
Array con el número de turnos, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
intervalos Estructura JSON formada por los campos mostrados a continuación Si
Array con el número de intervalos, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
dia_semana Int (1) Número del día de la semana: 1 = Lunes, 7 = Domingo, 0 = Diario Si
centro_trabajo Varchar(255) No
hora_entrada Varchar(5) Si
hora_salida Varchar(5) Si
tolerancia_entrada int(2) No
tolerancia_salida int(2) No
departamento Varchar (255) No
centros_trabajo Array Sí
guardar_localizacion Varchar (255) No
guardar_hora Varchar (255) No
modificar_hora Int (1) No
aviso_fin_jornada Int (1) No
terminal_corporativo Int (1) No
proponer_hora_salida Int (1) No
codigo Varchar (255) No
vacaciones_dias Int (1) No
vacaciones_tipo Enum ("N","L") N = Días Naturales; L = Días Laborables No
gestores de jornada Estructura JSON formada por los campos mostrados a continuación No
Array con los gestores de jornada, de los que se solicitarán los siguientes datos
Nombre del campo Tipo de dato Obligatorio
nombre Varchar (255) Sí
email Varchar (255) si
centros_trabajo Array con los centros de trabajo, de estos se solicitarán los siguientes datos No
Nombre del campo Tipo de datos Obligatorio
cif_sociedad Varchar(255) Sí
nombre_centro Varchar(255) Sí
Parámetros de salida
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
id_operacion Varchar(255) No
estado_operacion Varchar(255) Sí
mensaje_operacion Varchar(255) Sí
Códigos de operación
Estado de operación Mensaje de la operación
0000 El proceso se ha realizado con éxito.
0001 No se ha podido descargar el JSON enviado.
0002 El JSON recibido no es válido.
0003 La private key no es válida
0004 El cliente no existe
0005 El valor de NOMBRE_DEL_CAMPO no es válido
0006 El campo dirección de un centro de trabajo no ha sido encontrada.
0007 Las siguientes sociedades referenciadas en centros de trabajo o trabajadores no existen ni se han incluido en la petición: A11223344, B11223344
0008 El valor de localidad del centro de trabajo no corresponde con la provincia.
0009 Se ha asociado a un trabajado un centro de trabajo no pertenece a la sociedad indicada con CIF A11223344 o no existe.
0010 El cliente indicado no corresponde con la private key insertada
0011 Se han encontrado centros de trabajo con el mismo nombre en la misma sociedad.
0012 La suma de las horas ordinarias y las horas complementarias no puede ser mayor de 40 (Trabajador: 11223344A, CIF Sociedad: A11223344)
0013 El código de trabajador provisto está repetido.
0014 Los horarios no existen o tienen un formato incorrecto.
0015 La suscripcion del cliente ha expirado
Ejemplos
Petición de envío

Se envía una petición POST a la URL (http://api.ejornada.es/gestionar_jornadas), donde el parámetro es una variable del tipo JSON (json) con la Private Key (private_key) y el CIF del cliente (cif_cliente), así como el total de sociedades, centros de trabajo y trabajadores a gestionar, tal y como se muestra a continuación:

								{ 
								"private_key":"g9tdg44gGrk81pz",
								"cif_desarrollador":"38047186B",
								"cif_cliente":"N2505294E",
								"nombre_cliente":"Empresa S.L.",
								"email_cliente":"email@cliente.com",
								"direccion_cliente":"Violeta",
								"provincia_cliente":"Almería",
								"poblacion_cliente":"ALMERIA",
								"origen_cliente":"API",
								"fecha_baja":"24-01-2021",
								"avanzado":"1",
								"vacaciones_dias":"30",
								"vacaciones_tipo":"N",
								"sociedades":[ 
									{ 
										"nombre":"Empresa S.L.",
										"CIF":"N2505294E",
										"domicilio_social":"Jazmín",
										"guardar_localizacion":1,
										"guardar_hora":0,
										"modificar_hora":1,
										"aviso_fin_jornada":0,
										"proponer_hora_salida":0
									}
								],
								"centros_trabajo":[ 
									{ 
										"nombre":"Centro A",
										"localidad":"Almería",
										"provincia":"Almería",
										"lat":"36.8425611",
										"lng":"-2.4650892",
										"tipo_via":"Calle",
										"calle":"Gran Capitán",
										"numero":"5",
										"codigo_postal":"04003",
										"cif_sociedad":"N2505294E",
										"guardar_localizacion":"0",
										"guardar_hora":"1",
										"modificar_hora":"0",
										"aviso_fin_jornada":"1",
										"terminal_corporativo":"0",
										"proponer_hora_salida":"1"
									}
								],
								"trabajadores":[ 
									{ 
										"nombre_usuario":"Antonio Rodríguez Zapata",
										"nif_usuario":"16365771Y",
										"email_usuario":"trabajador@empresa.com",
										"cif_sociedad":"N2505294E",
										"fecha_alta":"24-01-2020",
										"vacaciones_dias":"30",
										"vacaciones_tipo":"N",
										"centros_trabajo":[ 
											"Centro A"
										],
										"departamento":"Departamento 1",
										"horario":[ 
											{ 
											"nombre":"Horario de Invierno",
											"fecha_inicio":"01-01-2020",
											"fecha_fin":"30-06-2020",
											"turnos":[ 
												{ 
													"intervalos":[ 
														{ 
														"dia_semana":1,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":2,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":3,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":4,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":5,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														}
													]
												},
												{ 
													"intervalos":[ 
														{ 
														"dia_semana":1,
														"centro_trabajo":"Centro A",
														"hora_entrada":"16:00",
														"hora_salida":"19:30",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":2,
														"centro_trabajo":"Centro A",
														"hora_entrada":"16:00",
														"hora_salida":"19:30",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15",
														"minutos_libres":"30"
														}
													]
												}
											],
											"configuracion":{ 
												"intervalos":[ 
													{ 
														"dia_semana":1,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":2,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":3,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":4,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":5,
														"minutos_libres":"15"
													}
												]
											}
											},
											{ 
											"nombre":"Horario de Verano",
											"fecha_inicio":"01-07-2020",
											"fecha_fin":"31-08-2020",
											"turnos":[ 
												{ 
													"intervalos":[ 
														{ 
														"dia_semana":1,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":2,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":3,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":4,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														},
														{ 
														"dia_semana":5,
														"centro_trabajo":"Centro A",
														"hora_entrada":"08:00",
														"hora_salida":"15:00",
														"tolerancia_entrada":"15",
														"tolerancia_salida":"15"
														}
													]
												}
											],
											"configuracion":{ 
												"intervalos":[ 
													{ 
														"dia_semana":1,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":2,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":3,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":4,
														"minutos_libres":"15"
													},
													{ 
														"dia_semana":5,
														"minutos_libres":"15"
													}
												]
											}
											},
											{ 
											"nombre":"Horario de Invierno",
											"fecha_inicio":"01-09-2020",
											"fecha_fin":"31-12-2020"
											}
										]
									}
								]
								}
Respuesta recibida
								{
								"id_operacion":"123456789999999",
								"estado_operacion":"0000",
								"mensaje_operacion":"El proceso se ha realizado con éxito."
								}
Zona de pruebas
Probar mediante petición JSON
Datos de entrada
Enviar formulario
Respuesta

WS Gestión de trabajadores

Parámetros de entrada
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
private_key Varchar (255) Sí
token Varchar (255) No
cif_desarrollador Varchar(255) Sí
cif_cliente Varchar (255) Sí
cif_sociedad Varchar (255) Sí
nif_trabajador Varchar (255) Sí
Parámetros de salida
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
id_operacion Varchar(255) No
estado_operacion Varchar(255) Sí
mensaje_operacion Varchar(255) Sí
respuesta Estructura JSON con los datos del trabajador Sí
Códigos de operación
Estado de operación Mensaje de la operación
0000 El proceso se ha realizado con éxito.
0001 No se ha podido descargar el JSON enviado.
0002 El JSON recibido no es válido.
0003 La private key no es válida
0004 El cliente no existe
0005 La sociedad indicada no existe
0006 El trabajador indicado no existe
0015 La suscripcion del cliente ha expirado
Ejemplos
Petición de envío

Se envía una petición POST a la URL (http://api.ejornada.es/datos_trabajador), donde el parámetro es una variable del tipo JSON (json) con la Private Key (private_key) y el CIF del cliente (cif_cliente), así como el total de sociedades, centros de trabajo y trabajadores a gestionar, tal y como se muestra a continuación:

								{ 
								"private_key":"g9tdg44gGrk81pz",
								"cif_desarrollador":"38047186B",
								"cif_cliente":"N2505294E",
								"nif_trabajador":"75244223N",
								"cif_sociedad":"V7323510J"
								}
Respuesta recibida
							{
								"id_operacion":"123456789999999",
								"estado_operacion":"0000",
								"mensaje_operacion":"El proceso se ha realizado con éxito.",
								"respuesta":"{"codigo":"3425345","nombre":"ANTONIO","apellido1":"DOBLAS","apellido2":"RODRIGUEZ"}"
								}
Zona de pruebas
Probar mediante petición JSON
Datos de entrada
Enviar formulario
Respuesta

WS Gestión de fichajes

Parámetros de entrada
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
private_key Varchar (255) Sí
token Varchar (255) No
cif_desarrollador Varchar(255) Sí
cif_cliente Varchar (255) Sí
cif_sociedad Varchar (255) Sí
nif_trabajador Varchar (255) Sí
desde Date Sí
hasta Date Sí
Parámetros de salida
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
id_operacion Varchar(255) No
estado_operacion Varchar(255) Sí
mensaje_operacion Varchar(255) Sí
respuesta Estructura JSON con los fichajes Sí
Códigos de operación
Estado de operación Mensaje de la operación
0000 El proceso se ha realizado con éxito.
0001 No se ha podido descargar el JSON enviado.
0002 El JSON recibido no es válido.
0003 La private key no es válida
0004 El cliente no existe
0005 La sociedad indicada no existe
0006 El trabajador indicado no existe
0007 Falta el campo 'desde'
0008 Falta el campo 'hasta'
0015 La suscripcion del cliente ha expirado
Ejemplos
Petición de envío

Se envía una petición POST a la URL (http://api.ejornada.es/fichajes_trabajador), donde el parámetro es una variable del tipo JSON (json) con la Private Key (private_key) y el CIF del cliente (cif_cliente), así como el total de sociedades, centros de trabajo y trabajadores a gestionar, tal y como se muestra a continuación:

								{ 
								"private_key":"g9tdg44gGrk81pz",
								"cif_desarrollador":"38047186B",
								"cif_cliente":"N2505294E",
								"nif_trabajador":"75244223N",
								"cif_sociedad":"V7323510J",
								"desde":"01-01-2020",
								"hasta":"28-02-2020"
								}
Respuesta recibida
							[
								{"fecha":"2020-02-03 08:08:00","creado":"2020-02-20 12:47:52","es_salida":"0","lat":"36.83","lng":"-2.40741","gps_activo":"0","origen":"web","fecha_modificacion":null,"fecha_firma":null,"requiere_firma":"1","requiere_validacion":"0","validado":"1"},
								{"fecha":"2020-02-03 15:00:00","creado":"2020-02-20 12:48:11","es_salida":"1","lat":"36.83","lng":"-2.40741","gps_activo":"0","origen":"web","fecha_modificacion":"2020-03-26 00:06:00","fecha_firma":null,"requiere_firma":"1","requiere_validacion":"0","validado":"1"},
								{"fecha":"2020-02-27 08:01:30","creado":"2020-02-27 11:19:31","es_salida":"0","lat":"36.83","lng":"-2.40741","gps_activo":"1","origen":"app","fecha_modificacion":"2020-03-26 00:07:32","fecha_firma":null,"requiere_firma":"1","requiere_validacion":"0","validado":"1"}
							]
Zona de pruebas
Probar mediante petición JSON
Datos de entrada
Enviar formulario
Respuesta

WS Marcar cliente facturado

Parámetros de entrada
Nombre del campo Tipo de dato Obligatorio
private_key varchar(255) Sí
cif_cliente varchar(255) Sí
cif_desarrollador varchar(255) No
facturado Int (1) No
Parámetros de salida
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
id_operacion Varchar(255) No
estado_operacion Varchar(255) Sí
mensaje_operacion Varchar(255) Sí
Códigos de operación
Estado de operación Mensaje de la operación
0000 El proceso se ha realizado con éxito.
0001 No se ha podido descargar el JSON enviado.
0002 El JSON recibido no es válido.
0003 La private key no es válida
0005 Usted no tiene acceso a este recurso
0006 El valor de facturado debe ser 1 o 0
0007 Ha fallado la actualización. Consulte con el programador.
0008 Ha fallado la recepción del json. Consulte con el programador.
0010 El cliente indicado no corresponde con la private key insertada
0015 La suscripcion del cliente ha expirado
Ejemplos
Petición de envío

Se envía una petición POST a la URL (http://api.ejornada.es/api_set_cliente_facturado), donde el parámetro es una variable del tipo JSON (json) con la Private Key (private_key) y el CIF del cliente (cif_cliente), así como el campo facturado para marcar al cliente como tal, vease ejemplo:

								{
									"private_key":"g9tdg42gGrk81pz",
									"cif_desarrollador":"38047186B",									
									"cif_cliente":"V7323559J",									
									"facturado":1
								}
Respuesta recibida
								{
									"id_operacion":"123456789999999",
									"estado_operacion":"0000",
									"mensaje_operacion":"El proceso se ha realizado con éxito."
								}
Zona de pruebas
Probar mediante petición JSON
Datos de entrada
Enviar formulario
Respuesta

WS Clientes TPV

Datos de cliente y de licencia que no estén facturados

Parámetros de entrada
Nombre del campo Tipo de dato Obligatorio
private_key varchar(255) Sí
cif_cliente varchar(255) No
cif_desarrollador varchar(255) No
Parámetros de salida
Nombre del campo Tipo de dato Obligatorio
json Estructura JSON formada por los campos mostrados a continuación Sí
id_operacion Varchar(255) No
estado_operacion Varchar(255) Sí
mensaje_operacion Varchar(255) Sí
datos Text Sí
Códigos de operación
Estado de operación Mensaje de la operación
0000 El proceso se ha realizado con éxito.
0001 No se ha podido descargar el JSON enviado.
0002 El JSON recibido no es válido.
0003 La private key no es válida
0004 El Cliente no existe
0005 Usted no tiene acceso a este recurso
0007 Ha fallado la actualización. Consulte con el programador.
0008 Ha fallado la recepción del json. Consulte con el programador.
0010 El cliente indicado no corresponde con la private key insertada
0015 La suscripcion del cliente ha expirado
Ejemplos
Petición de envío

Se envía una petición POST a la URL (http://api.ejornada.es/api_get_info_facturacion_clientes_tpv), donde el parámetro es una variable del tipo JSON (json) con la Private Key (private_key), el CIF del cliente (cif_cliente) y el CIF del desarrollador (cif_desarrollador):

								{
									"private_key":"g9tdg42gGrk81pz",
									"cif_desarrollador":"38047186B"
								}
Respuesta recibida
								{
									"id_operacion":"123456789999999",
									"estado_operacion":"0000",
									"mensaje_operacion":"El proceso se ha realizado con éxito."
									"datos": [
										{
											nombre:"Antonio",
											email:"antonio@gmail.com",
											direccion:"CL Alegria 22",
											municipio:"Huercal-Overa",
											provincia:"Almería",
											nif:"33599867M",
											fecha_inicio:'2020-07-28',
											fecha_fin:'2020-07-28',
											facturado:0,										
										},
										{
											nombre:"Mariano Gomez",
											email:"mgomez@gmail.com",
											direccion:"CL Ferrocarril 345 A",
											municipio:"Pulpi",
											provincia:"Almería",
											nif:"45789632J",
											fecha_inicio:'2020-05-01',
											fecha_fin:'2020-09-29',
											facturado:0,										
										}
									]
								}
Zona de pruebas
Probar mediante petición JSON
Datos de entrada
Enviar formulario
Respuesta