Portal para desarrolladores de API Management: Preguntas más frecuentes

  • Artículo

SE APLICA A: Desarrollador | Básico | Básico v2 | Estándar | Estándar v2 | Premium

¿Qué ocurre si necesito una funcionalidad que no se admite en el portal?

Dispone de las siguientes opciones:

  • Para las pequeñas personalizaciones, use un widget integrado para agregar HTML personalizado. Actualmente, el widget de código HTML personalizado no está disponible en los niveles v2 de API Management.

  • Para personalizaciones más grandes, cree y cargue un widget personalizado en el portal para desarrolladores administrados. Actualmente, los widgets personalizados no están disponibles en los niveles v2 de API Management.

  • Autohospede el portal para desarrolladores, solo si necesita realizar modificaciones en el núcleo del código base del portal para desarrolladores.

  • Abra una solicitud de característica en el repositorio de GitHub.

Más información sobre la personalización y ampliación de la funcionalidad del portal para desarrolladores.

¿Puedo tener varios portales para desarrolladores en un servicio API Management?

Puede tener un portal administrado y varios portales autohospedados. El contenido de todos los portales se almacena en el mismo servicio API Management, por lo que serán idénticos. Si quiere diferenciar la apariencia y la funcionalidad de los portales, puede autohospedarlos con sus propios widgets personalizados, que personalizan dinámicamente las páginas en runtime, por ejemplo, en función de la dirección URL.

¿Admite el portal plantillas de Azure Resource Manager o es compatible con el kit de recursos de DevOps de API Management?

No.

¿Se guarda el contenido del portal con la funcionalidad de copia de seguridad y restauración en API Management?

No.

¿Debo habilitar una conectividad de red virtual adicional para las dependencias del portal administrado?

En la mayoría de los casos, no.

Si el servicio API Management se encuentra en una red virtual interna, solo se puede acceder al portal para desarrolladores desde dentro de la red. El nombre de host del punto de conexión de administración debe resolverse en la dirección VIP interna del servicio desde la máquina que se usa para acceder a la interfaz administrativa del portal. Asegúrese de que el punto de conexión de administración está registrado en el DNS. En el caso de una configuración incorrecta, verá un error: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Si el servicio API Management se encuentra en una red virtual interna y accede a él a través de Application Gateway desde Internet, no olvide habilitar la conectividad con el portal para desarrolladores y los puntos de conexión de administración de API Management. Es posible que tenga que deshabilitar las reglas de Web Application Firewall. Consulte este artículo de la documentación para obtener más detalles.

He asignado un dominio de API Management personalizado y el portal publicado no funciona

Después de actualizar el dominio, debe volver a publicar el portal para que los cambios surtan efecto.

He agregado un proveedor de identidades y no lo veo en el portal

Después de configurar un proveedor de identidades (por ejemplo, Azure AD o Azure AD B2C), debe volver a publicar el portal para que los cambios surtan efecto. Asegúrese de que las páginas del portal para desarrolladores incluyen el widget con los botones de OAuth.

He configurado la delegación y el portal no la usa

Después de configurar la delegación, debe volver a publicar el portal para que los cambios surtan efecto.

Los demás cambios de configuración de API Management no se han propagado en el portal para desarrolladores

La mayoría de los cambios de configuración (por ejemplo, la red virtual, el inicio de sesión y los términos del producto) requieren volver a publicar el portal.

Obtengo un error de CORS al usar la consola interactiva

La consola interactiva realiza una solicitud de API del lado cliente desde el explorador. Resuelva el problema de CORS agregando una directiva de CORS en las API o configure el portal para usar un proxy CORS. Para obtener más información, consulte Habilitación de CORS para la consola interactiva en el portal para desarrolladores de API Management.

Obtengo un error de CORS al usar el widget de código HTML personalizado

Al usar el widget de código HTML personalizado en su entorno, es posible que vea un error de CORS al interactuar con el IFrame cargado por el widget. Este problema se produce porque el IFrame se proporciona contenido de un origen diferente al del portal para desarrolladores. Para evitar este problema, puede usar un widget personalizado en su lugar.

¿Qué permisos necesito para editar el portal para desarrolladores?

Si ve el error Oops. Something went wrong. Please try again later. al abrir el portal en el modo administrativo, es posible que no tenga los permisos necesarios (RBAC de Azure).

El portal requiere el permiso Microsoft.ApiManagement/service/users/token/action en el ámbito /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1.

Puede usar el siguiente script de PowerShell para crear un rol con el permiso necesario. Recuerde cambiar el parámetro <subscription-id>.

#New Portals Admin Role 
Import-Module Az 
Connect-AzAccount 
$contributorRole = Get-AzRoleDefinition "API Management Service Contributor" 
$customRole = $contributorRole 
$customRole.Id = $null
$customRole.Name = "APIM New Portal Admin" 
$customRole.Description = "This role gives the user ability to log in to the new Developer portal as administrator" 
$customRole.Actions = "Microsoft.ApiManagement/service/users/token/action" 
$customRole.IsCustom = $true 
$customRole.AssignableScopes.Clear() 
$customRole.AssignableScopes.Add('/subscriptions/<subscription-id>') 
New-AzRoleDefinition -Role $customRole

Una vez creado el rol, se puede conceder a cualquier usuario de la sección Control de acceso (IAM) de Azure Portal. Al asignar este rol a un usuario, se asignará el permiso en el ámbito del servicio. El usuario podrá generar tokens de SAS en nombre de cualquier usuario en el servicio. Como mínimo, este rol debe asignarse al administrador del servicio. El siguiente comando de PowerShell muestra cómo asignar el rol a un usuario user1 en el ámbito más bajo para evitar la concesión de permisos innecesarios al usuario:

New-AzRoleAssignment -SignInName "user1@contoso.com" -RoleDefinitionName "APIM New Portal Admin" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1"

Una vez concedidos los permisos a un usuario, este debe cerrar sesión e iniciar sesión de nuevo en Azure Portal para que los nuevos permisos surtan efecto.

Veo el error Unable to start the portal. See if settings are specified correctly (...)

Este error se muestra cuando se produce un error en una llamada GET a https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview. La interfaz administrativa del portal emite la llamada desde el explorador.

Si el servicio API Management se encuentra en una red virtual, consulte la pregunta de conectividad de la red virtual.

El error de llamada también puede deberse a un certificado TLS/SSL, que se asigna a un dominio personalizado y no es de confianza para el explorador. Como mitigación, puede quitar el dominio personalizado del punto de conexión de administración. API Management revertirá el punto de conexión predeterminado con un certificado de confianza.

¿Cuál es la compatibilidad del explorador con el portal?

Browser Compatible
Apple Safari Sí1
Google Chrome Sí1
Microsoft Edge Sí1
Microsoft Internet Explorer No
Mozilla Firefox Sí1

1 Se admite en las dos últimas versiones de producción.

El desarrollo local de mi portal autohospedado ya no funciona

Si la versión local del portal para desarrolladores no puede guardar ni recuperar información de la cuenta de almacenamiento o de la instancia de API Management, es posible que los tokens de SAS hayan expirado. Para corregirlo, genere nuevos tokens. Para obtener instrucciones, consulte el tutorial para autohospedar el portal para desarrolladores.

¿Cómo se deshabilita el registro en el portal para desarrolladores?

Si no necesita la funcionalidad de registro habilitada de forma predeterminada en el portal para desarrolladores, puede deshabilitarla con estos pasos:

  1. Vaya a la instancia de API Management en Azure Portal.

  2. En el menú de Portal para desarrolladores, seleccione Identidades.

  3. Elimine cada proveedor de identidades que aparezca en la lista. Seleccione cada proveedor, luego el menú contextual ( ... ) y, por último, Eliminar.

    Eliminación de proveedores de identidades

  4. Vaya a la interfaz administrativa del portal para desarrolladores.

  5. Quite los vínculos de registro y los elementos de navegación en el contenido del portal. Para obtener información sobre cómo personalizar el contenido del portal, consulte Tutorial: Acceso y personalización del portal para desarrolladores.

  6. Modifique el contenido de la página de registro para quitar los campos usados para escribir datos de identidad, en caso de que los usuarios naveguen directamente a ellos.

    Otra posibilidad es elimnar la página de registro. Actualmente, se usan las API de REST contentItem para enumerar y eliminar esta página.

  7. Guarde los cambios y vuelva a publicar el portal.

¿Cómo puedo quitar el contenido del portal para desarrolladores aprovisionado en mi servicio API Management?

Proporcione los parámetros necesarios en el script scripts.v3/cleanup.bat en el repositorio de GitHub del portal para desarrolladores y ejecute el script.

cd scripts.v3
.\cleanup.bat
cd ..

¿Cómo habilito la autenticación de inicio de sesión único (SSO) en el portal para desarrolladores autohospedado?

Entre otros métodos de autenticación, el portal para desarrolladores admite el inicio de sesión único (SSO). Para autenticarse con este método, tiene que realizar una llamada a /signin-sso con el token en el parámetro de consulta:

https://contoso.com/signin-sso?token=[user-specific token]

Generación de tokens de usuario

Puede generar tokens específicos del usuario (incluidos tokens de administrador) mediante la operación Obtención del token de acceso compartido de la API REST de API Management.

Nota

El token debe tener una codificación URL.

Contenido relacionado

Obtenga más información sobre el portal para desarrolladores:

Examine otros recursos: