Elegir una API¶
Lurana BPM expone dos API HTTP. Hacen cosas distintas, y la mayoría de las integraciones solo necesita una.
| API del espacio de trabajo | API REST clásica | |
|---|---|---|
| Base | /{espacio}/{idioma}/lurana/api |
/api/1.0/{espacio}/ |
| Autenticación | El inicio de sesión devuelve un token de acceso y uno de refresco | Token OAuth2 de un cliente registrado |
| Documentado | La superficie de integración | El subconjunto soportado |
| Conviene para | Integraciones nuevas y todo lo que hace la propia aplicación | Integraciones ya construidas sobre ella, y operaciones que solo existen ahí |
Cuál usar¶
Empieza por la API del espacio de trabajo. Es la superficie que usa la aplicación, está documentada página por página, y cubre autenticación, el espacio de trabajo del caso, búsqueda y aprovisionamiento de usuarios.
Usa la API clásica cuando necesites algo que la API del espacio de trabajo no expone:
- filtros de búsqueda avanzada, guardados por usuario;
- marcadores sobre tareas iniciales y la lista de tareas que se pueden iniciar;
- subir a una variable del caso y ejecutar un desencadenador sobre un caso;
- notas con paginación y los endpoints de variables por delegación;
- información del supervisor, reasignación en lote e impersonación;
- los permisos del proceso y las tareas iniciales de un usuario.
Las dos comparten el modelo de datos pero no las respuestas: la clásica devuelve los
nombres de campo heredados (APP_UID, DEL_INDEX) y la del espacio de trabajo devuelve
sus propias formas. Elige una por integración en lugar de mezclarlas.
Qué no está documentado¶
La API clásica tiene 534 rutas. Las 392 que quedan fuera de esta guía son:
- el cliente móvil (
Light), obsoleto; - la analítica obsoleta (
Dashboard,ReportingIndicators) y el sobrecargadoConsolidated; System,Catalog,Process,TestyMetrics;- los recursos de administración que reemplazan las pantallas nuevas: usuarios, grupos, roles, departamentos, calendarios, servidores de correo y categorías de procesos;
- el diseñador editando sus propios objetos, que es para lo que está la interfaz del Diseñador.
Si una integración necesita alguno de ellos, avísanos: el producto los soporta, solo no forman parte del contrato documentado.