Políticas integradas

Políticas integradas são configuradas no contexto de uma API. É possível usar o editor de montagem do API Designer para incluir uma política integrada em uma API e para configurar as propriedades para essa política

Também é possível incluir políticas integradas em uma API criando um arquivo de definição OpenAPI .. Para obter mais informações, consulte “Criação de um arquivo de definição do OpenAPI ”.

A tabela a seguir mostra a lista de políticas integradas que estão disponíveis. A tabela contém links para informações de configuração para as definições de política integradas e as definições de política do OpenAPI . As políticas são iguais, mas elas são criadas de maneiras diferentes.

Tabela 1. Políticas integradas

Tabela de políticas integradas

Política integrada	Política OpenAPI	Descrição
Log de atividades	activity-log	Use a política de Registro de Atividades para definir suas preferências de registro para as atividades da API armazenadas no Analytics d IBM API ConnectIBM API ConnectIBM API Connect. As preferências que você especificar substituirão as configurações padrão para coletar e armazenar detalhes da atividade da API. Nota: a política do Log de atividades não é suportada no conjunto para uma API cujo tipo de gateway é DataPower API Gateway. Em vez disso, a criação de log de atividade é definida nas configurações de design da API. Para obter mais detalhes, consulte “Configurando o registro de atividades ” ( OpenAPI 2.0 ) ou “Configurando o registro de atividades ” ( OpenAPI 3.0 ).		Funcionalidade fornecida no projeto da API; consulte “Configurando o registro de atividades ” ( OpenAPI2.0 ) ou “Configurando o registro de atividades ” ( OpenAPI3.0 )
Segurança do Cliente	client-security	Fornece uma variedade de opções para autenticar o acesso do cliente às suas APIs, estendendo os recursos da especificação OpenAPI.
Extrair	extrair	Use a política de extração para extrair e transformar dados dos campos da sua API.
GatewayScript	gatewayscript	Use a política gatewayscript para executar um programa DataPower GatewayScript especificado. A política " GatewayScript " está disponível apenas com o Premium subscription.
Gerar JWT	jwt-generate	Use a política de segurança Gerar JWT em IBM API ConnectAI Gateway para gerar um JSON Web Token (JWT).
Análise de custo do GraphQL	análise de custos do GraphQL	Use a política de análise de custos do ` GraphQL ` para obter uma análise de custos de uma consulta de destino.
GraphQL Executar	graphql-execute	Use a política de execução " GraphQL " para executar uma consulta do tipo " GraphQL " utilizando subconsultas.
Introspecção do GraphQL	graphql-introspect	Use a política de introspecção do ` GraphQL ` para realizar a introspecção de um esquema ` GraphQL `.
IF	IF	Use a política if para aplicar uma seção do conjunto quando uma condição é atendida.		Funcionalidade oferecida pelo switch
Chamar	chamar	Aplicar a política Chamar para chamar outro serviço de dentro do conjunto. A resposta do backend é armazenada na variável message.body ou na variável de objeto de resposta, se ela estiver definida. A política pode ser usada com dados JSON ou XML e pode ser aplicada diversas vezes em seu conjunto.
JSON para XML	json-to-xml	Use a política JSON para XML para converter a carga útil de contexto de sua API do formato JavaScript Object Notation (JSON) para o formato extensible markup language (XML).
Lambda	Lambda	Use a política do Lambda para acionar diretamente funções d AWS Lambda s a partir da API, sem utilizar o Amazon Web Services (AWS) API Gateway
Log	log	Use a política de registro para personalizar ou substituir a configuração padrão de registro de atividades de uma API.
Mapa	mapa	Use a política Mapa para aplicar transformações em seu fluxo de conjuntos e especificar relacionamentos entre variáveis.
Modelo de mensagem	modelo de mensagem	Use a política de modelo de mensagem para criar uma resposta de API simulada para o DataPower API Gateway.
OAuth	OAuth	Use a OAuth política para realizar um processamento de OAuth e com base nas configurações definidas do provedor OAuth.
operation-switch	operation-switch	Use a política operation-switch para aplicar uma seção do conjunto a uma operação específica.
Análise	analisar	Use a política Analisar para controlar a análise de um documento de entrada Quando o documento de entrada é uma sequência JSON, a sequência é analisada em vez de copiada.
Proxy	Proxy	Aplicar a política Proxy para chamar outra API dentro de seu conjunto, especialmente se a API separada contiver uma carga útil grande. A resposta do backend é armazenada no message.body e na variável de objeto de resposta, se ela estiver definida. Somente uma política é permitida para ser executada por fluxo de montagem exclusivo.		Funcionalidade fornecida pelo Invoke
Limite de taxa	RateLimit	Use a política de Limite de taxa para aplicar um ou mais limites de taxa ou de burst em qualquer ponto em seu fluxo de conjunto da API (interface de programação de aplicativos) Os limites de taxa e de distribuição restringem o número de chamadas que um aplicativo pode fazer para uma API em um período de tempo especificado.
Informações de limite de taxa	ratelimitinfo	Use a política "Rate Limit Info" para retornar informações sobre seus limites de taxa.
Edição de dados Redação - DataPower API Gateway Redação - DataPower Gateway (compatível com v5 )	redact - DataPower API Gateway redact - DataPower Gateway (compatível com v5 )	Use a política Redação para remover ou editar completamente os campos especificados do corpo da solicitação, do corpo de resposta e dos logs de atividades. Talvez você ache essa política útil para remover ou bloquear dados sensíveis (por exemplo, detalhes do cartão de crédito) por razões jurídicas, de segurança ou outras.
Configurar variável	set-variable	Use a política Configurar Variável para configurar o valor de uma variável de tempo de execução ou para limpar uma variável de tempo de execução ou para incluir uma variável de cabeçalho.
comutador	comutador	Use a política de alternância para executar uma das diversas seções do conjunto com base na condição especificada que foi atendida.
lançar	lançar	Use a política de lançamento para lançar um erro quando ele é atingido durante a execução de um
Segurança do usuário	user-security	Use a política user-security para extrair credenciais de um usuário, autenticar essas credenciais e obter autorização do usuário.
Validar Validar - DataPower API Gateway Validar - DataPower Gateway (compatível com v5 )	validar - DataPower API Gateway validar - DataPower Gateway (compatível com v5 )	Use a política Validar para validar a carga útil em um fluxo de conjuntos com relação a um esquema JSON ou XML.
Validar JWT	jwt-validate	Use a política de segurança Validar JWT para ativar a validação de um JSON Web Token (JWT) em uma solicitação antes de permitir acesso às APIs.
Validar token do nome de usuário	Validate-usernametoken	Use a política Validar Token do Nome do Usuário para validar um Web Services Security (WS-Security) UsernameToken em uma carga útil SOAP antes de permitir acesso ao recurso protegido.
XML para JSON	xml-to-json	Use a política XML para JSON para converter a carga útil de contexto de sua API do formato extensible markup language (XML) para JavaScript Object Notation (JSON).
XSLT	xslt	Use a política XSLT para aplicar uma conversão XSLT para a carga útil da definição de API. A política XSLT está disponível apenas com o Premium subscription.