Fichaloto

Blog Integración

Qué preguntarle a una API de RRHH antes de escribir una línea

6 min de lectura

Todos los fabricantes dicen que tienen API. Lo interesante es qué cubre, qué se niega a hacer, y si obedece las mismas reglas que las pantallas.

Cobertura: ¿es el producto entero o la demo?

La primera pregunta es aburrida y decide todo: ¿qué entidades puedes leer y escribir? Hay muchas APIs que cubren clientes y proyectos y se paran justo donde empiezan los datos interesantes: horarios, turnos, saldos de ausencias, registro de jornada, permisos.

Buena señal: una API cuya lista de entidades se genera de la misma definición que las pantallas de importación y exportación, en vez de mantenerse a mano. Cuando son dos listas, siempre hay una desactualizada, y suele ser contra la que estás programando.

Escrituras: ¿la misma puerta y las mismas reglas?

El fallo que más tiempo cuesta es una API que escribe directa a la base de datos, saltándose las validaciones que aplican las pantallas. Se descubre meses después, en forma de una población de registros que no se podrían haber creado desde la interfaz y que media aplicación no sabe pintar.

Pregúntalo directamente: crear un registro por la API, ¿pasa por las mismas validaciones, dispara los mismos efectos y queda en la misma auditoría que crearlo en pantalla? Si la respuesta no es un sí inmediato, presupuesta la limpieza.

Qué debería ser de solo lectura, y por qué eso tranquiliza

Una API bien diseñada se niega a cosas. Lo que tiene valor probatorio —un registro de jornada encadenado, una factura emitida, un histórico de movimientos— debería poder leerse y no escribirse, porque escribir una de esas filas a mano sería falsificar justo lo que hace que merezca la pena guardarla.

Merece la pena darle la vuelta cuando estés evaluando: una API que te deja hacer POST de cualquier cosa no es más potente, es menos fiable. Lo que quieres es una puerta documentada para el caso legítimo —cargar el histórico de tu programa anterior, por ejemplo— que pase por el mismo código que genera los registros bien, en vez de rodearlo.

Llaves, alcance y las preguntas aburridas de seguridad

Tres cosas que comprobar, las tres rápidas de verificar y caras de descubrir tarde.

  • ¿La llave está acotada a una cuenta? En un producto multiempresa toda consulta tiene que filtrar por cuenta en el modelo, no en el controlador. Pregunta qué pasa si pides un identificador de otro: la respuesta honesta es un 404, no una lista vacía.
  • ¿La llave lleva rol? Una llave debería llevar permisos igual que una persona, de forma que una integración de solo lectura lo sea por construcción y no por buena voluntad. Que existan de fábrica un rol de API de lectura y otro de lectura y escritura ahorra marcar cuarenta casillas a mano y equivocarse en una.
  • ¿El secreto se enseña una sola vez? Si puedes volver a leer el secreto de una llave ya creada desde la interfaz, también puede quien entre en esa pantalla.

Preguntas frecuentes

¿Tenéis webhooks?

Hoy Fichaloto va de sondeo: las entidades admiten un filtro por fecha de modificación, así que una integración puede traerse solo lo que ha cambiado. Es menos elegante que un webhook y bastante más fácil de depurar a las tres de la tarde.

¿En qué huso van las fechas?

En UTC, siempre, en la API. El día laboral al que cuenta una jornada se guarda aparte como día local, porque si no un turno de noche se parte en dos días distintos según la época del año.

Todo esto está montado dentro de Fichaloto. Ver cómo funciona.

Seguir leyendo