- 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
Autoriza y realiza llamadas a la API directamente en la interfaz de Orchestrator 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 la cerradura está abierta, no está autorizado.
- Selecciona Autorizar. Se muestra 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.
- Selecciona Autorizar. Se muestra una ventana nueva que confirma que has sido autorizado.
- 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.
- In the expanded method window, Select Try it out.
- Especifique valores de parámetro si es necesario.
- Select Execute. The request is executed. A bearer authorization header is automatically used for your requests.
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.
- Select Authorize and on the displayed Available authorizations page, Select Logout to revoke the expired token.
- 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.