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.

Se puede acceder a la definición de Swagger de la API de Orchestrator añadiendo el sufijo /swagger/ui/index#/ a tu URL de Orchestrator. Por ejemplo, https://{yourDomain}/swagger/ui/index#/.

Nota: La autenticación de Swagger caduca según los parámetros establecidos en tu instancia de Orchestrator. De forma predeterminada, está establecido en 30 minutos. Puedes cambiarlo modificando el valor del parámetro Auth.Cookie.Expire , en el archivo Web.config .

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:

1. Busca el botón Autorizar en la esquina superior derecha de la página API de Orchestrator (OrchestratorURL/swagger). Si la cerradura está abierta, no está autorizado.
   
   

   

   
   
2. Haz clic en Autorizar. Se mostrará la ventana Autorizaciones disponibles .
   Nota: Actualmente admitimos un esquema de autorización llamado OAuth2.

   
   

   

   
   
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. Haz clic en Autorizar. Se mostrará una nueva ventana que confirma que se le ha autorizado.
5. Una vez hecho esto, haz clic en Cerrar o en X para cerrar la ventana de Autorizaciones disponibles . El botón Autorizar muestra un candado cerrado, lo que significa que está autorizado.

Envío de 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.
   
   

   

   
   
2. En la ventana del método expandido, haz clic en Probar.
3. Especifique valores de parámetro si es necesario.
4. Haz clic en Ejecutar. Se ejecuta la solicitud. Se utiliza automáticamente un encabezado de autorización del portador para tus solicitudes.
   
   

   

   
   

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 (OrchestratorURL/swagger). La cerradura debe estar cerrada.
   
   

   

   
   
2. Haz clic en Autorizar y en la página Autorizaciones disponibles que se muestra, haz clic en Cerrar sesión para revocar el token caducado.
   
   

   

   
   
3. Cierra la ventana Autorizaciones disponibles haciendo clic en Cerrar o X y 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 (OrchestratorURL/swagger). 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.