API#

La sección API permite consultar la documentación para conectarse al servidor mediante la API y crear tokens de acceso.

Abra API en el menú izquierdo. Si no aparece, haga clic en el engranaje junto a su nombre de usuario y fije API en la configuración del menú.

1. Documentación Swagger#

La pestaña Swagger contiene la referencia de la API en formato Swagger.

La información está agrupada por secciones de Sherpa Process Discovery.

2. Documentación ReDoc#

La pestaña ReDoc contiene la referencia de la API en formato ReDoc.

La información también está agrupada por secciones de Sherpa Process Discovery.

3. Tokens#

La pestaña Token muestra los tokens de API creados en el sistema.

La tabla muestra el nombre, los roles asignados, la fecha y hora de expiración y la fecha de creación de cada token. Puede crear, filtrar, editar y eliminar tokens.

Crear un token#

Haga clic en Crear token para abrir el diálogo de creación.

Escriba un nombre, seleccione el rol que define las acciones permitidas y establezca una fecha de expiración. Si es necesario, marque Sin vencimiento. Pulse Crear token para terminar o Cancelar para cerrar sin guardar.

4. Uso del token y de las fechas en la API#

Para llamar a un método protegido de la API, envíe el token creado en la cabecera Authorization: Basic <Base64(token)>: codifique en Base64 el valor del token sin nombre de usuario, dos puntos ni contraseña. Por ejemplo, para example-token la cabecera es Authorization: Basic ZXhhbXBsZS10b2tlbg==. El token solo permite las acciones concedidas por sus Roles. Solicite permisos adicionales al administrador si los necesita. Envíe la cabecera solo por HTTPS y guarde el token original como secreto.

Las respuestas de API v1 devuelven fechas y horas en UTC con el sufijo Z, por ejemplo 2026-05-15T10:00:00.123456Z. En filtros y campos de fecha de las solicitudes, utilice RFC 3339 con zona horaria explícita: Z o un desplazamiento como +03:00. No envíe valores sin zona horaria porque no identifican un instante único.