Autorizar llamadas a API en Swagger

Acceder a Swagger

Si está utilizando Swagger para probar nuestra API, simplemente inicie sesión en su instancia de Orchestrator en una pestaña separada.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/.

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:

1. 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
   

   

   
   

2. Selecciona Autorizar. Se mostrará la ventana Autorizaciones disponibles .

   Nota: Actualmente admitimos un esquema de autorización llamado OAuth2.
   Figura 2. Autorizaciones disponibles
   

   

   
   
3. 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.
4. Selecciona Autorizar. Se mostrará una nueva ventana confirmando que has sido autorizado.
5. Una vez hecho esto, selecciona Cerrar o 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:

1. 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
   

   

   
   
2. En la ventana de método expandida, selecciona Pruébalo.
3. Especifique valores de parámetro si es necesario.
4. Selecciona Ejecutar. La solicitud se ejecuta. Se utiliza automáticamente un encabezado de autorización al portador para tus solicitudes.
   Figura 4. Encabezado de autorización del 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:

1. 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
   

   

   
   
2. Selecciona Autorizar y, en la página Autorizaciones disponibles , selecciona Cerrar sesión para revocar el token caducado.
   Figura 6. Autorizaciones disponibles
   

   

   
   
3. Cierra la ventana Autorizaciones disponibles seleccionando Cerrar o 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:

1. 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.
2. Haz clic en Autorizar y en la página Autorizaciones disponibles que se muestra, haz clic en Cerrar sesión.
3. Cierra la ventana Autorizaciones disponibles haciendo clic en Cerrar o X. El botón Autorizar muestra un candado abierto, lo que significa que no tienes autorización.