- Primeros pasos
- Autenticación
- Definición de Swagger
- Léeme
- Autorizar llamadas a API en Swagger
- Gestionar recursos lógicos
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
- API de gestión de plataformas
Autorizar y realizar llamadas a la API de Orchestrator directamente en la interfaz de Swagger
Acceder a Swagger
Para acceder a la API Swagger de Orchestrator, anexa /swagger/index.html a la URL de Orchestrator. Por ejemplo, https://{yourDomain}/swagger/index.html.
La API que ves en Swagger depende directamente de la instancia de Orchestrator que utilices. Para realizar solicitudes directamente en Swagger, inicia sesión en Orchestrator en otra pestaña.
Obtener un token de acceso
Para autorizar llamadas a la API a través de la interfaz de usuario de Swagger para los servicios de Orchestrator, realiza los siguientes pasos:
-
Busca el botón Autorizar en la esquina superior derecha de la página API de Orchestrator. Si el bloqueo está abierto, no estás autorizado.
Figura 1. Botón Autorizar
-
Selecciona Autorizar. Se muestra la ventana Autorizaciones disponibles.
Nota:Actualmente admitimos un esquema de autorización llamado OAuth2.
Figura 2. Autorizaciones disponibles
-
All scopes are preselected such that you can experiment with all endpoints in the Orchestrator API.
Clear them if you want to restrict access to certain APIs. 4. Select Authorize. A new window is displayed confirming you have been authorized. 5. Once done, select Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.
Enviar solicitudes
Mientras estés autorizado, puedes realizar solicitudes en los recursos de la API de Orchestrator de la siguiente manera:
-
Expande un recurso de API de Orchestrator con el que deseas realizar una operación. El candado cerrado significa que tiene autorización.
Figura 3. Recurso de API no autorizado
-
En la ventana método expandido, selecciona Pruébalo.
-
Especifique valores de parámetro si es necesario.
-
Selecciona Ejecutar. La solicitud se ejecuta. Se utiliza automáticamente un encabezado de autorización de portador para tus solicitudes.
Figura 4. Encabezado de autorización de portador
Generar un nuevo token de acceso
Cuando el token de acceso caduca, recibirá una respuesta 401: You are not authenticated! . El encabezado de autorización del portador sigue presente para tus solicitudes, pero el token de acceso ha caducado. Cuando esto sucede, debes invalidar el token caducado y generar un nuevo token de acceso:
-
Busca el botón Autorizar en la esquina superior derecha de la página API de Orchestrator. La cerradura debe estar cerrada.
Figura 5. Botón Autorizar
-
Selecciona Autorizar y, en la página Autorizaciones disponibles que se muestra, selecciona Cerrar sesión para revocar el token caducado.
Figura 6. Autorizaciones disponibles
-
Cierra la ventana Autorizaciones disponibles haciendo clic en Cerrar o en X y, luego, obtén un token de acceso como se describe en la sección Obtener un token de acceso.
Revocar acceso
Cuando haya terminado de trabajar con la interfaz de usuario de Swagger, debe invalidar el token de acceso que ha utilizado:
- Busca el botón Autorizar en la esquina superior derecha de la página API de Orchestrator. La cerradura debe estar cerrada, lo que significa que estás autorizado.
- Select Authorize and on the displayed Available authorizations page, Select Logout.
- Cierra la ventana Autorizaciones disponibles haciendo clic en Cerrar o en X. El botón Autorizar muestra un candado abierto que significa que no estás autorizado.