Técnica e integraciones

Módulo API de eBrigade

Conecte eBrigade a su sistema de información

Deje de volver a introducir su personal, cuadrantes y titulaciones de una herramienta a otra. La API de eBrigade expone sus datos mediante flujos de entrada y salida documentados y protegidos por clave: su sistema de RR. HH., su software de nóminas o su portal interno se sincronizan automáticamente, sin desarrollo a medida por parte de eBrigade.

Incluido en todos los planes

Incluido sin coste adicional en todos los planes de eBrigade, prueba de 30 días sin tarjeta.

El módulo API en 20 segundos

Ilustración · datos de ejemplo

¿Qué es el módulo API de eBrigade?

Claves API de importación/exportación, API REST v2 y flujos de entrada/salida para conectar eBrigade con su sistema de información. Incluido sin coste adicional en todos los planes de eBrigade.

¿Por qué usar la API?

Sus datos de eBrigade están aislados de sus otras herramientas: sistema de RR. HH., software de nóminas, software de gestión o portal web. Cada exportación manual a Excel, cada vez que se vuelve a teclear un empleado o una cualificación, cuesta tiempo y acaba creando discrepancias entre sus bases de datos. Sin acceso programático, sus equipos de TI no tienen una forma fiable de mantener eBrigade alineado con su sistema de información de referencia.

Lo que cambia la API en eBrigade

La API expone su personal, sus actividades y participaciones, sus competencias y fechas de caducidad, sus organizaciones, sus inscripciones, sus disponibilidades y ausencias, sus fichajes, sus vehículos y su material mediante flujos estandarizados. Sus desarrolladores leen estos datos (GET) y envían datos desde sus herramientas externas (POST) con una simple clave. La API REST v2 devuelve JSON coherente, paginado y autodocumentado; cada llamada se contabiliza, se limita y se refleja en un panel de uso, y el acceso puede restringirse solo a sus propias direcciones IP.

Funciones

Lo que puede hacer con API

Una clave de importación y una de exportación bajo su control

Dos claves distintas, una para los flujos entrantes (importación) y otra para los salientes (exportación), se generan y regeneran en un clic desde el área de administración. Regenerar una clave comprometida invalida al instante la anterior, sin afectar al otro flujo.

Flujos de entrada para sincronizar sus datos

Envíe su personal, actividades/formaciones y competencias a eBrigade desde su sistema de RR. HH. o directorio de referencia. La importación gestiona tanto actualizaciones como altas (create_if_not_exists) y la correspondencia por ID interno o ID externo (use_external_id), incluidos UUID.

Flujos de salida para alimentar su sistema de información

Exponga en solo lectura su personal, actividades y participación en un periodo, el catálogo de competencias y las caducidades de cada persona, sus organizaciones, las inscripciones a actividades de pago, disponibilidades, ausencias y fichajes, así como sus vehículos y material. Ideal para alimentar la nómina, el reporting o un panel de business intelligence.

API REST v2 moderna y autodocumentada

Autenticación mediante la cabecera Authorization: Bearer, respuestas JSON uniformes {success, data, meta}, paginación (page, per_page), actualizaciones parciales de un registro con PATCH, cabeceras CORS y códigos HTTP explícitos. Endpoints, parámetros y ejemplos cURL se documentan directamente en la interfaz, sin documentación externa.

Panel de cupos y consumo

La instancia tiene un límite (por defecto 10.000 peticiones/día y 60 peticiones/minuto por clave), con cabeceras X-RateLimit y una respuesta HTTP 429 cuando se supera. Un panel muestra las peticiones del día, la cuota restante, el último endpoint llamado y la hora de la última llamada.

Acceso restringido a una lista de direcciones IP autorizadas

Active el filtrado por dirección IP para aceptar solo llamadas de servidores autorizados: cualquier petición desde una IP fuera de la lista de permitidas se rechaza (HTTP 403), incluso con una clave válida.

Y además: Nuevos datos exportados · Biblioteca de conectores

En imágenes

API en la app

Capturas de la aplicación real, no maquetas.

eBrigade, Módulo API — claves api y cuotas : Una clave para los flujos entrantes y otra para los salientes, regenerables con un clic, con el uso del día y el límite vigente.
Claves API y cuotasUna clave para los flujos entrantes y otra para los salientes, regenerables con un clic, con el uso del día y el límite vigente.
eBrigade, Módulo API — los endpoints documentados : Personal, actividades, participaciones, competencias, organizaciones, disponibilidad: cada recurso con su método y sus parámetros.
Los endpoints documentadosPersonal, actividades, participaciones, competencias, organizaciones, disponibilidad: cada recurso con su método y sus parámetros.
eBrigade, Módulo API — ejemplos de llamadas listos para copiar : Peticiones completas para cada flujo: su equipo técnico no tiene que adivinar el formato esperado.
Ejemplos de llamadas listos para copiarPeticiones completas para cada flujo: su equipo técnico no tiene que adivinar el formato esperado.
Cómo funciona

Paso a paso

  1. Genere sus claves API

    Desde el área de administración, active la API de exportación y genere la clave de exportación y el token de importación con un clic. Puede regenerarlos en cualquier momento para revocar el acceso.

  2. Bloquee y pruebe el acceso

    Si lo necesita, active la restricción a una lista blanca de direcciones IP y pruebe sus llamadas con los ejemplos cURL que ofrece la interfaz para cada endpoint (personas, eventos, competencias, secciones, inscripciones).

  3. Conecte sus herramientas y supervise

    Su sistema de información consulta (GET) o envía (POST) datos a través de los flujos documentados. El panel de uso muestra las peticiones del día, la cuota restante y la última llamada para que vigile sus integraciones.

Preguntas frecuentes del módulo

Preguntas frecuentes

¿Puede una herramienta externa escribir en el libro de servicio?

Sí. La API v2 acepta un mensaje en el libro de incidencias de una actividad (POST /api/v2/events/{id}/logbook): texto, título, hora, importancia y nombre de la herramienta, que aparece como remitente. Un identificador de referencia hace la llamada idempotente: la misma alerta enviada dos veces crea una sola línea. El libro se consulta en la misma dirección, con un filtro «since». La escritura requiere tener activada la API de importación.

¿A qué tipos de datos se puede acceder mediante la API?

Acceso de lectura (flujos de salida): personal, actividades y participación en un periodo, lista de referencia de competencias y fechas de caducidad de las competencias, organizaciones, inscripciones a actividades de pago, disponibilidad, ausencias, fichajes, flota de vehículos y material. Acceso de escritura (flujos de entrada): importación y actualización del personal (ficha completa o solo los campos enviados, con PATCH), importación de actividades/formaciones y asignación de competencias.

¿Cuántas claves API se pueden crear?

La API se basa en dos claves: una para la exportación (flujos salientes) y un token para la importación (flujos entrantes). Cada una se genera y regenera de forma independiente desde el área de administración. En la API v2, una sola clave puede servir para ambos usos mediante la cabecera Authorization: Bearer.

¿Hay una API REST moderna o hay que usar el formato antiguo?

Versión 2: la antigua versión 1 ya no se ofrece, sus endpoints solo se mantienen para las integraciones existentes. La API v2 añade autenticación Bearer, JSON normalizado {success, data, meta}, paginación, cabeceras CORS y códigos HTTP explícitos, manteniendo la compatibilidad con los endpoints v1 existentes.

¿Hay límites de peticiones?

Sí. Por defecto, la instancia está limitada a 10.000 peticiones al día y cada clave a 60 peticiones por minuto. Las respuestas incluyen cabeceras X-RateLimit y devuelven un código HTTP 429 cuando se supera el límite. Un panel de uso permite seguir su consumo en tiempo real.

¿Cómo se protege el acceso a la API?

Además de la clave, puede activar la restricción a una lista de direcciones IP autorizadas: cualquier llamada desde una IP que no esté en la lista se rechaza (HTTP 403). La autenticación se hace preferentemente mediante una cabecera Bearer y no en claro en la URL.

Pruebe eBrigade con el módulo API

Prueba de eBrigade de 30 días · Sin tarjeta · Módulo incluido en su plan

Módulo incluido en eBrigade Prueba de eBrigade de 30 días · Sin tarjeta · Incluido en el plan
Prueba gratuita de 30 días