- 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 robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- 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
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 las llamadas a la API a través de la interfaz de usuario de Swagger en tu instancia de Orchestrator, realiza los siguientes pasos:
-
Look for the Authorize button at the top right corner of the Orchestrator API page (
OrchestratorURL/swagger). If the lock is open, you are unauthorized.
-
Haz clic en Autorizar. Se mostrará la ventana Autorizaciones disponibles .
Nota:Actualmente admitimos un esquema de autorización llamado OAuth2.
-
Todos los ámbitos están preseleccionados para que puedas experimentar con todos los puntos finales en la API de Orchestrator. Bórralos si quieres restringir el acceso a ciertas API.
-
Haz clic en Autorizar. Se mostrará una nueva ventana confirmando que has sido autorizado.
-
Una vez hecho esto, haz clic en Cerrar o en X para cerrar la ventana Autorizaciones disponibles . El botón Autorizar muestra un candado cerrado, lo que significa que estás autorizado.
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.
Figure 1. Unauthorized API resource
-
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.
Figure 2. Bearer authorization header
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:
-
Look for the Authorize button at the top right corner of the Orchestrator API page (
OrchestratorURL/swagger). The lock should be closed.
-
Haz clic en Autorizar y, en la página Autorizaciones disponibles , haz clic en Cerrar sesión para revocar el token caducado.
-
Close the Available authorizations window by clicking Close or X and then obtain an access token as described on the Obtaining an access token section.
Revocar acceso
Cuando haya terminado de trabajar con la interfaz de usuario de Swagger, debe invalidar el token de acceso que ha utilizado:
- Look for the Authorize button at the top right corner of the Orchestrator API page (
OrchestratorURL/swagger). The lock should be closed, meaning you are authorized. - Haz clic en Autorizar y en la página Autorizaciones disponibles que se muestra, haz clic en Cerrar sesión.
- 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.