Descripción del servicio API Management

  • 3 minutos

API Management proporciona la funcionalidad esencial para garantizar un programa de API de éxito mediante compromisos con desarrolladores, información detallada empresarial, análisis, seguridad y protección. Cada API consta de una o varias operaciones y se puede agregar a uno o varios productos. Para usar una API, los desarrolladores se suscriben a un producto que contiene esa API y después pueden llamar a la operación de la API cumpliendo cualquier directiva de uso que pueda estar en vigor.

Componentes de API Management

Azure API Management se compone de una puerta de enlace API, un plano de administración y un portal para desarrolladores. Estos componentes están hospedados en Azure y totalmente administrados de forma predeterminada. API Management está disponible en varios niveles que tienen capacidades y características diferentes.

  • La puerta de enlace de la API es el extremo que:

    • Acepta llamadas de API y las enruta a los back-end apropiados
    • Verifica las claves de API y otras credenciales presentadas con las solicitudes
    • Aplica cuotas de uso y límites de frecuencia
    • Transforma solicitudes y respuestas especificadas en las instrucciones de directiva
    • Almacena en caché las respuestas para mejorar la latencia de respuesta y minimizar la carga en los servicios back-end
    • Emite registros, métricas y seguimientos para la supervisión, los informes y la solución de problemas

  • El plano de administración es la interfaz administrativa donde se configura el programa de API. Utilícelo para:

    • Aprovisionar y definir la configuración del servicio API Management
    • Definir o importar el esquema de API
    • Empaquetar API en productos
    • Configurar directivas, como cuotas o transformaciones, en las API
    • Obtener información del análisis
    • Administrar usuarios

  • El portal para desarrolladores es un sitio web totalmente personalizable que se genera automáticamente con la documentación de las API. Mediante el portal para desarrolladores, los desarrolladores pueden:

    • Leer documentación de la API
    • Llamar a una API a través de la consola interactiva
    • Crear una cuenta y suscribirse para obtener claves de API
    • Acceder a análisis sobre su propio uso
    • Descargar definiciones de API
    • Administrar claves de API

Productos

Los productos son la forma de presentar las API a los desarrolladores. Los productos en Administración de API tienen una o varias API y se configuran con un título, una descripción y términos de uso. Los productos pueden ser de tipo Abierto o Protegido. Para poder usar los productos protegidos es necesario suscribirse antes a ellos, mientras que los productos abiertos pueden usarse sin suscripción. La aprobación de la suscripción se configura en el ámbito de producto y puede requerir la aprobación del administrador o aprobarse automáticamente.

Grupos

Los grupos se usan para administrar la visibilidad de productos a los desarrolladores. API Management tiene los siguientes grupos invariables del sistema:

  • Administradores: controlan las instancias del servicio API Management y crean las API, las operaciones y los productos que los desarrolladores usan. Los administradores de suscripciones a Azure son parte de este grupo.
  • Desarrolladores: usuarios autenticados del portal para desarrolladores que compilan aplicaciones mediante las API. Los desarrolladores, después de que se les concede acceso al portal para desarrolladores, crean aplicaciones que llaman a las operaciones de una API.
  • Invitados: usuarios del portal para desarrolladores no autenticados. Se les concede determinado acceso de solo lectura como, por ejemplo, la posibilidad de ver API pero no llamarlas.

Además de estos grupos del sistema, los administradores pueden crear grupos personalizados o usar grupos externos en inquilinos de Microsoft Entra asociados.

Desarrolladores

Los desarrolladores representan las cuentas de usuario de una instancia del servicio API Management. Los desarrolladores pueden ser creados por administradores o invitados por estos y también pueden suscribirse desde el Portal para desarrolladores. Cada desarrollador es miembro de uno o varios grupos y se puede suscribir a los productos que conceden visibilidad a esos grupos.

Directivas

Las directivas son una colección de declaraciones que se ejecutan secuencialmente en la solicitud o respuesta de una API. Entre las declaraciones más usadas se encuentran la conversión de formato de XML a JSON y la limitación de tasa de llamadas para restringir el número de llamadas entrantes de un desarrollador, pero también hay muchas otras directivas disponibles.

Las expresiones de directiva pueden utilizarse como valores de atributos o valores de texto en cualquiera de las directivas de API Management, a menos que la directiva especifique lo contrario. Algunas directivas como Flujo de control y Establecer variable se basan en expresiones de directiva.

Las directivas se pueden aplicar en distintos ámbitos, en función de sus necesidades: global (todas las API), un producto, una API específica o una operación de API.