Saltar al contenido
Precios Ayuda
Cumplir e integrar

API y webhooks

Si tienes un programa que necesita los fichajes, le das una clave de lectura y que los lea él; y si lo que quieres es que ese programa META fichajes —un torno, un ERP—, hay un permiso aparte para eso. Y si quieres que se entere en el momento de que alguien ha fichado, hay webhooks firmados y con reintentos.

Claves con permisos Sin conectores por nombre
1440×900 Captura de Empresa › Integraciones con la lista de claves de lectura: tres filas con su nombre, qué puede leer cada una, la fecha de caducidad y cuántas veces se ha usado. Sin logos de otros programas y sin ninguna clave real legible. img/producto-api-integraciones.webp
Empresa › Integraciones, las claves y los destinos de webhook.
En qué plan entra

Las integraciones entran en Pro

La API y los webhooks son la última planta de la escalera: se pagan cuando ya tienes otro programa al otro lado que necesita estos datos.

Pro · desde 2,99 €/empleado activo/mes
Qué dice la escalera de planes sobre integrar Ficheo con otro programa.
Qué entraGratisEsencialEquipoPro
API y webhooksNoNoNoSí, con límites
CSV para nóminaLegal / genéricoGenéricoPlantillasIntegraciones
MultiempresaNoNoNoVista limitada
La API y los webhooks son del plan Pro

Pro incluye la API y los webhooks con límites, y una vista limitada de multiempresa. Si tienes un grupo con varias sociedades o vas a leer mucho volumen, escríbenos y lo miramos caso por caso.

Precios por empleado activo y mes, facturados al año y sin IVA. Están todos en la página de precios.

Las claves

Permiso a permiso, y se ve quién las usa

Se crean en Empresa › Integraciones. Eliges qué puede hacer cada clave y cuándo caduca. La clave se enseña una sola vez, en una ventana que no se cierra sin querer, con botón de copiar y la línea de curl ya montada para probarla en el momento.

  • Cuatro recursos de lectura: personas, fichajes en bruto, jornadas ya calculadas y ausencias con su tipo y su estado.
  • Y uno de escritura, aparte y que hay que conceder a mano: meter fichajes. Es lo que necesita un torno, un ERP o un bot para que pasar por la puerta cuente como fichar.
  • Lo que entra por ahí queda con origen «Integración» y con el nombre de la clave en el historial del fichaje. Un fichaje que aparece sin que nadie lo haya tocado es lo primero que pregunta una inspección.
  • Las jornadas vienen con las horas hechas. Calcularlas desde los fichajes obliga a repetir del otro lado las pausas, el turno de noche y las jornadas abandonadas.
  • Se ve cuántas veces se ha usado cada clave y cuándo fue la última vez.
  • Retirar una clave avisa antes de qué se va a romper.
  • Una clave es de una empresa y solo devuelve datos de esa empresa.
1440×900 Captura de la ventana de clave recién creada en Empresa › Integraciones: la clave tapada salvo los últimos caracteres, el botón de copiar y debajo la línea de curl de ejemplo. Sin ninguna clave real completa y sin datos de personas. img/producto-api-clave-nueva.webp
La clave se enseña una vez, con la línea de curl para probarla.
Los webhooks

Firmados, con reintentos y con freno

Avisan a una dirección tuya cuando pasan dos cosas: alguien ficha, y se resuelve una ausencia. Van firmados, y la firma está explicada en la propia pantalla con un ejemplo, para que del otro lado puedas comprobar que el aviso viene de aquí.

  • Si tu servidor está caído, el aviso no se pierde: se reintenta.
  • Si un destino falla veinte veces seguidas se para solo y lo dice, en vez de seguir golpeando una puerta que nadie abre.
  • Hay botón de prueba de envío y la lista de los últimos intentos con su resultado.
El CSV del cierre de mes
800×520 Dos personas en una oficina pequeña mirando la misma pantalla de ordenador, una de ellas señalando algo con el dedo. Luz de tarde por una ventana lateral, sin logos de marcas y sin ningún texto legible en la pantalla. img/producto-api-equipo-oficina.webp
Si no quieres escribir código

Dos caminos que cubren casi todos los casos

La mayoría de las veces lo que hace falta no es una integración, sino un fichero. El CSV del cierre de mes lleva una fila por persona con horas, ausencias, extras, nocturnas y festivos, y cualquier programa de nóminas lo importa mapeando las columnas una vez.

  • La puerta de entrada de fichajes, con clave propia, para que un aparato o un puente tuyo mande marcajes en JSON.
  • Es la misma puerta que usan los terminales de pared. Escribe, pero solo hace eso: meter fichajes.
Conectar un reloj de pared
1440×900 Captura de la pantalla de webhooks con un destino dado de alta y la lista de los últimos intentos: hora, evento y resultado de cada uno, con uno de ellos fallido. Sin direcciones reales de clientes y sin datos personales. img/producto-api-webhooks-panel.webp
Los últimos intentos de cada destino, con su resultado.
Claro desde el principio

Lo que hay y lo que no, antes de que lo montes

Esta página empieza por el final a propósito, porque es donde más se exagera en este mercado.

Lo que hace hoy

  • Claves con caducidad y con permisos por recurso, de lectura y de escritura por separado.
  • Personas, fichajes, jornadas calculadas y ausencias.
  • Webhooks al fichar y al resolver una ausencia, firmados y con reintentos.
  • Uso de cada clave y últimos intentos de cada destino, a la vista.
  • Aislamiento entre empresas comprobado con pruebas en cada subida.

Lo que no hace

  • No hay conectores con productos concretos. No se nombra ninguno, ni de nóminas, ni ERP, ni plataformas de automatización.
  • Lo único que se puede escribir desde fuera son fichajes. No se aprueban ausencias, ni se dan de alta personas, ni se cambian horarios.
  • Un mes cerrado no se reabre desde la API. Lo que ya se mandó a la gestoría no lo toca un programa.
  • No hay OAuth2: la autenticación es una clave que viaja en una cabecera.
  • No hay entorno de pruebas separado. Se prueba con una clave de lectura contra los datos reales.
  • No hay portal de documentación público con ejemplos en varios lenguajes. Lo que hay es la pantalla del panel.
Preguntas

Preguntas frecuentes

¿Puedo crear fichajes desde la API?

Sí, con el permiso de escribir fichajes, que se concede aparte. Sirve para que un torno, un ERP o un puente cuenten como fichaje. Puedes decir el tipo o dejar que lo decida el servidor mirando cómo está esa persona, repetir la misma llamada no duplica horas, y queda escrito con qué clave entró. Un mes cerrado no se reabre por ahí. Para los relojes de pared hay además una puerta propia que habla su protocolo.

¿Hay límite de peticiones?

En el plan Pro la API y los webhooks van con límites. Cada clave lleva control de uso y se ve cuántas veces se ha usado. Si vas a hacer algo intensivo, dilo antes y lo miramos.

¿Podéis hacerme la integración con mi programa?

Se puede hablar. Lo que no vamos a hacer es poner el logo de tu programa en la web y llamarlo conector sin haberlo construido.

¿Cómo compruebo que un webhook viene de vosotros?

Con la firma. Va en el propio aviso y la pantalla de webhooks explica cómo se calcula, con un ejemplo, para que la verifiques del otro lado.

Sigue leyendo

Exportar las horas a nóminas

El CSV del mes que resuelve la mayoría de los casos sin escribir una línea de código.

Ver la exportación

Terminales de fichaje

Si lo que quieres conectar es un aparato de pared y no un programa.

Ver los terminales

Registro de jornada para la Inspección

Qué se puede extraer del registro y con qué garantías.

Ver el registro legal
Empieza hoy

Empieza gratis y añade la API cuando la necesites

El fichaje y el registro legal no se pagan. Las integraciones se encienden el día que tengas algo al otro lado.