Políticas incorporadas

IBM® API Connect incluye una serie de políticas incorporadas que puede utilizar para aplicar sentencias de política preconfiguradas a una operación para controlar un aspecto del proceso en el servidor de pasarela cuando se invoca una API.

Nota: Aunque algunas políticas incorporadas se pueden utilizar con DataPower® Gateway (v5 compatible) y DataPower API Gateway, algunas políticas están restringidas a una pasarela determinada. Los iconos siguientes indican con qué pasarela se puede utilizar cada política:
  • Icono de DataPower GatewayIndica que la política se puede ejecutar en DataPower Gateway (v5 compatible). El DataPower Gateway no está disponible en API Connect Enterprise as a Service.
  • Icono API GatewayIndica que la política se puede ejecutar en DataPower API Gateway.

Para obtener más información sobre los dos tipos de pasarela, consulte API Connecttipos de pasarela.

Las políticas incorporadas se configuran en el contexto de una API. Puede utilizar el editor de ensamblaje de API Designer para añadir una política incorporada a una API y para configurar las propiedades de dicha política.

También puede añadir políticas incorporadas a una API creando un archivo de definición OpenAPI . Para obtener más información, consulte Creación de un archivo de definición de OpenAPI.

La tabla siguiente muestra la lista de políticas incorporadas que están disponibles. La tabla contiene enlaces a información de configuración para las definiciones de política incorporadas y las definiciones de política OpenAPI . Las políticas son las mismas, pero se crean de maneras distintas.
Tabla 1. Políticas incorporadas
Política incorporada Política OpenAPI Descripción Icono de pasarela DataPower Icono de pasarela DataPower
Registro de actividad activity-log Utilice la política Registro de actividad para configurar las preferencias de registro para la actividad de API que se almacena en el análisis de IBM API Connect . Las preferencias que especifique van a alterar temporalmente los valores predeterminados en cuanto a la recopilación y almacenado de detalles de la actividad de la API.
Nota: La política de registro de actividad no está soportada en el ensamblaje para una API cuyo tipo de pasarela es DataPower API Gateway. En su lugar, se configura el registro de actividad en los valores de diseño de la API. Para obtener detalles, consulte Configuración del registro de actividad (OpenAPI 2.0) o Configuración del registro de actividad (OpenAPI 3.0).
Sí Sí

Funcionalidad proporcionada en el diseño de la API; consulte Configuración del registro de actividad (OpenAPI 2.0) o Configuración del registro de actividad (OpenAPI 3.0)

Seguridad del cliente client-security Proporciona diversas opciones para autenticar el acceso del cliente a las API, ampliando las prestaciones de la especificación OpenAPI. Nee Sí
Extract Extract Utilice la directiva Extraer para extraer y transformar datos de los campos de su API. Nee Sí
GatewayScript GatewayScript Utilice la política gatewayscript para ejecutar un programa DataPower GatewayScript especificado.

La política GatewayScript sólo está disponible con el " Premium subscription.

Sí Sí
Generar JWT jwt-generate Utilice la política de seguridad Generar JWT en IBM API Connect para generar una señal web JSON (JWT). Sí Sí
Análisis de costes de GraphQL Análisis de costes de GraphQL Utilice la política GraphQL Cost Analysis para devolver un análisis de costes de una consulta de destino. Nee Sí
GraphQL Ejecutar graphql-ejecutar Utilice la política GraphQL Execute para ejecutar una consulta GraphQL utilizando subconsultas. Nee Sí
Introspección de GraphQL graphql-introspectar Utilice la política GraphQL Introspect para introspeccionar un esquema GraphQL. Nee Sí
IF IF Utilice la política if para aplicar una sección del ensamblaje cuando se cumple una condición. Sí Sí

Funciones del conmutador

invocar invocar Aplicar la política Invocar para llamar a otro servicio desde dentro del ensamblaje. La respuesta del programa de fondo se almacena en la variable message.body o en la variable de objeto de respuesta si es que está definida. La política se puede utilizar con datos JSON o XML y se puede aplicar varias veces en el ensamblaje. Sí Sí
JSON a XML Json-To-Xml Utilice la política JSON a XML para convertir la carga útil de contexto de la API del formato JavaScript Object Notation (JSON) al formato extensible markup language (XML). Sí Sí
Lambda Lambda Utilice la política Lambda para desencadenar directamente las funciones Lambda de AWS desde la API sin utilizar la API Gatewayde Amazon. Nee Sí
Correlación mapa Utilice la política Correlacionar para aplicar transformaciones al flujo de ensamblaje y especificar relaciones entre variables. Sí Sí
Plantilla de mensaje mensaje-plantilla Utilice la política Plantilla de mensaje para crear una respuesta de API simulada para DataPower API Gateway. Nee Sí
OAuth oaut Utilice la política OAuth para realizar el proceso de OAuth basándose en los valores de proveedor de OAuth definidos. Nee Sí
operation-switch operation-switch Utilice la política operation-switch para aplicar una sección del ensamblaje a una operación específica. Sí Sí
Analizar analizar Utilice la política Analizar para controlar el análisis de un documento de entrada. Cuando el documento de entrada es una serie JSON, la serie se analiza en lugar de copiarse encima. Nee Sí
Proxy Proxy Aplicar la política Proxy para invocar otra API dentro del ensamblaje, especialmente si la API separada contiene una carga útil grande. La respuesta del programa de fondo se almacena en message.body y en la variable de objeto de respuesta si es que está definida. Únicamente se permite ejecutar una política por flujo de ensamblaje exclusivo. Sí Sí

Funciones de Invoke

Límite de velocidad RateLimit Utilice la política Límite de velocidad para aplicar uno o varios límites de velocidad o ráfaga en cualquier punto del flujo de ensamblaje de API. Los límites de velocidad y ráfaga restringen el número de llamadas que una aplicación puede realizar a una API en un periodo de tiempo especificado. Nee Sí
Información de límite de velocidad información sobre el límite de velocidad Utilice la política Información sobre límites de tarifa para obtener información sobre sus límites de tarifa. Nee Sí

Redacción

Redacción - DataPower API Gateway

Redacción - DataPower Gateway (compatible conv5 )

redactar - DataPower API Gateway

redact - DataPower Gateway (compatible conv5 )

Utilice la política Redaction para eliminar completamente o redactar los campos especificados del cuerpo de solicitud, el cuerpo de respuesta y los registros de actividad. Encontrará esta política útil para eliminar o bloquear datos confidenciales (por ejemplo, detalles de tarjeta de crédito) por razones legales, de seguridad o de otro tipo. Sí Sí
Establecer variable set-variable Utilice la política Establecer variable para establecer el valor de una variable de tiempo de ejecución, o para borrar una variable de tiempo de ejecución, o para añadir una variable de cabecera. Sí Sí
conmutador conmutador Utilizar la política switch para ejecutar una de varias secciones del ensamblaje en función de qué condición especificada se cumple. Sí Sí
Throw Throw Utilice la política throw para emitir un error cuando se alcanza durante la ejecución de un flujo de ensamblaje. Sí Sí
Seguridad de usuario user-security Utilice la política user-security para extraer las credenciales de un usuario, autenticarlas y obtener autorización del usuario. Nee Sí

Validar

Validar - DataPower API Gateway

Validar - DataPower Gateway (compatible conv5 )

validar - DataPower API Gateway

validar - DataPower Gateway (compatible conv5 )

Utilice la política Validar para validar la carga útil en un flujo de ensamblaje con respecto a un JSON o un esquema XML. Sí Sí
Validar JWT jwt-validate Utilice la política de seguridad Validar JWT para habilitar la validación de una señal web JSON (JWT) en una solicitud antes de permitir el acceso a las API. Sí Sí
Validar señal de nombre de usuario Validate-usernametoken Utilice la política Validar señal de nombre de usuario para validar un UsernameToken de seguridad de servicios web (WS-Security) en una carga útil SOAP antes de permitir el acceso al recurso protegido. Sí Nee
XML a JSON xml a json Utilice la política XML a JSON para convertir la carga útil de contexto de la API del formato XML (Extensible Markup Language) a JavaScript Object Notation (JSON). Sí Sí
XSLT XSLT Utilice la política XSLT para aplicar una transformación XSLT a la carga útil de la definición de API.

La política XSLT sólo está disponible con el ' Premium subscription.

Sí Sí
Inclusión de elementos en su ensamblaje de API OpenAPI 2.0, Inclusión de elementos en su ensamblaje de API OpenAPI 3.0