API REST

Los administradores crean tokens Bearer con ámbitos definidos para aplicaciones externas.

Vista general

Esta página describe el uso y los efectos más importantes de API REST. Si los cambios afectan a tickets, permisos, notificaciones o automatizaciones existentes, deben comprobarse primero en un entorno de pruebas.

Flujo de trabajo típico

  1. Buscar un usuario para un token. Utilice las vistas disponibles de búsqueda, filtro y detalle. Borre o cambie los filtros si no aparecen los registros esperados.

  2. Crear un token con nombre y ámbitos. Abra el formulario de administración o acción correspondiente, introduzca los valores necesarios y guarde solo después de comprobar las asignaciones y los campos obligatorios.

  3. Guardar de forma segura el valor del token. Ejecute la función en el formulario previsto y compruebe de inmediato el resultado en la vista correspondiente o en el ticket afectado.

  4. Desactivar el token. Compruebe primero qué registros o usuarios existentes se verán afectados. Siempre que sea posible, utilice la desactivación en lugar de la eliminación definitiva.

  5. Comprender el registro de solicitudes y la idempotencia. Ejecute la función en el formulario previsto y compruebe de inmediato el resultado en la vista correspondiente o en el ticket afectado.

  6. Abrir la descripción OpenAPI. Ejecute la función en el formulario previsto y compruebe de inmediato el resultado en la vista correspondiente o en el ticket afectado.

Notas

  • Los elementos de menú y las acciones visibles dependen de los permisos de grupo y programa del agente conectado.

  • Las entradas desactivadas suelen conservarse para tickets y evaluaciones existentes, pero ya no están disponibles para nuevas asignaciones.

  • Después de los cambios, pruebe al menos un caso de uso realista con un usuario del rol afectado.

API REST