Habilitación de CORS para la consola interactiva en el portal para desarrolladores de API Management

APLICA A: desarrollador | Básico | Básico v2 | Estándar | Estándar v2 | Premium | Premium v2

El uso compartido de recursos entre orígenes (CORS) es un mecanismo basado en encabezado HTTP que permite a un servidor indicar cualquier origen (dominio, esquema o puerto) distinto del suyo propio desde el que un explorador debe permitir la carga de recursos.

Para permitir que los visitantes del portal para desarrolladores de API Management usen la consola de prueba interactiva en las páginas de referencia de la API, habilite una directiva de CORS para las API en la instancia de API Management. Si el nombre de dominio del portal para desarrolladores no es un origen permitido para las solicitudes de API entre dominios, los usuarios de la consola de prueba verán un error de CORS.

En determinados escenarios, puede configurar el portal para desarrolladores como proxy CORS en lugar de habilitar una directiva de CORS para las API.

Prerrequisitos

• Completar la guía de inicio rápido siguiente: Creación de una instancia de Azure API Management

Vaya a la instancia de API Management.

1. En Azure Portal, busque y seleccione Servicios de API Management:

   

2. En la página Servicios de API Management , seleccione la instancia de API Management:

   

Habilitación de la directiva de CORS para las API

Puede habilitar una configuración para configurar automáticamente una directiva de CORS para todas las API de la instancia de API Management. También puede configurar manualmente una directiva de CORS.

Nota:

Solo se ejecuta una directiva de CORS. Si especifica varias directivas de CORS (por ejemplo, en el nivel de API y en el nivel de todas las API), es posible que la consola interactiva no funcione según lo previsto.

Activar automáticamente la política de CORS

1. En el menú izquierdo de la instancia de API Management, en Portal para desarrolladores, seleccione Información general del portal.
2. En Habilitar CORS, se muestra el estado de la configuración de directiva de CORS. Un cuadro de advertencia indica una directiva ausente o mal configurada.
3. Para habilitar CORS desde el portal para desarrolladores para todas las API, seleccione Habilitar CORS.

Habilitar manualmente la política de CORS

1. Seleccione el vínculo Aplicarlo manualmente en el nivel global para ver el código de directiva generado.
2. Vaya a Todas las API en la sección API de la instancia de API Management.
3. Seleccione el <icono /> en la sección Procesamiento de entrada .
4. En el editor de directivas, inserte la directiva en la <sección entrante> del archivo XML. Asegúrese de que el valor de origen< coincide con el> dominio del portal para desarrolladores.

Nota:

Si aplica la política CORS en el ámbito del Producto, en lugar del ámbito de la(s) API, y si la API utiliza la autenticación mediante clave de suscripción por medio de un encabezado, la consola no funcionará.

El explorador emite automáticamente una OPTIONS solicitud HTTP, que no contiene un encabezado con la clave de suscripción. Debido a la clave de suscripción que falta, API Management no puede asociar la OPTIONS llamada a un producto, por lo que no puede aplicar la directiva de CORS.

Como solución alternativa, puede pasar la clave de suscripción en un parámetro de consulta.

Configuración de CORS para el nombre de dominio personalizado

Si configura un dominio personalizado para el portal para desarrolladores y quiere que los visitantes usen la consola de prueba en páginas de referencia de API, asegúrese de habilitar CORS para el nombre de dominio del portal para desarrolladores personalizado.

Al configurar el dominio personalizado, puede habilitar una configuración para agregar un origen para el dominio del portal para desarrolladores personalizado en la directiva CORS. Si CORS ya estaba habilitado para el dominio predeterminado, ambos orígenes se incluirán en la directiva de CORS. Puede cambiar la configuración de directiva de CORS en cualquier momento.

Opción de proxy CORS

En algunos escenarios (por ejemplo, si la puerta de enlace de API Management está aislada en la red), puede configurar el portal para desarrolladores como un proxy CORS, en lugar de habilitar una directiva de CORS para las API. El proxy CORS redirige las solicitudes de API de la consola interactiva a través del backend del portal en tu instancia de API Management.

Nota:

Si las API se exponen a través de una puerta de enlace autohospedada o el servicio está en una red virtual, se requiere la conectividad desde el servicio back-end del portal para desarrolladores de API Management a la puerta de enlace.

Para configurar el proxy CORS, acceda al portal para desarrolladores como administrador:

1. En la página Información general de la instancia de API Management, seleccione Portal para desarrolladores. El portal para desarrolladores se abre en una nueva pestaña del explorador.
2. En el menú izquierdo de la interfaz administrativa, seleccione Páginas>APIs>Detalles.
3. En la página API: Detalles , seleccione el widget Operación: detalles y seleccione Editar widget.
4. Seleccione Usar proxy CORS.
5. Guarde los cambios en el portal y vuelva a publicar el portal.

Configuración de CORS para el portal para desarrolladores autohospedado

Si autohospeda el portal para desarrolladores, se necesita la siguiente configuración para habilitar CORS:

• Especifique el punto de conexión de back-end del portal mediante la opción backendUrl en los archivos de configuración. De lo contrario, el portal autohospedado no es consciente de la ubicación del servicio de servidor.

• Agregue valores de dominio de origen a la configuración del portal autohospedado que especifica los entornos donde se hospeda el portal autohospedado. Aprende más

Contenido relacionado

• Para obtener más información sobre cómo configurar una directiva, vea Establecer o editar directivas.
• Para obtener más información sobre la directiva de CORS, consulte la referencia de la directiva cors .