Autorizar llamadas a API en 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:

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.

   Figure 1. Authorize button
   

   

   
   

2. Select Authorize. The Available authorizations window is displayed.

   Nota: Actualmente admitimos un esquema de autorización llamado OAuth2.
   Figure 2. Available authorizations
   

   

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

1. Expande un recurso de API de Orchestrator con el que deseas realizar una operación. El candado cerrado significa que tiene autorización.
   Figure 3. Unauthorized API resource
   

   

   
   
2. In the expanded method window, select Try it out.
3. Especifique valores de parámetro si es necesario.
4. Select Execute. The request is executed. A bearer authorization header is automatically used for your requests.
   Figure 4. 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:

1. Busca el botón Autorizar en la esquina superior derecha de la página API de Orchestrator. La cerradura debe estar cerrada.
   Figure 5. Authorize button
   

   

   
   
2. Select Authorize and on the displayed Available authorizations page, select Logout to revoke the expired token.
   Figure 6. Available authorizations
   

   

   
   
3. Close the Available authorizations window by selecting 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:

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.