Esta página se aplica a Apigee, mas não a Apigee híbrida.
Confira a documentação da
Apigee Edge.
O Advanced API Security monitora continuamente suas APIs para protegê-las contra ameaças à segurança, incluindo ataques de clientes mal-intencionados e abusos. O Advanced API Security analisa o tráfego da API para identificar solicitações de API suspeitas e oferece ferramentas que podem bloquear ou sinalizar essas solicitações. Além disso, o Advanced API Security avalia as configurações da sua API para garantir que elas atendam aos padrões de segurança e oferece recomendações para melhorias, se necessário.
Se você é um cliente da Apigee de pagamento por uso, o Advanced API Security está disponível como um complemento pago. Neste tópico, descrevemos como ativar e gerenciar o complemento Advanced API Security para ambientes qualificados de pagamento por uso. Para mais informações sobre como usar o Advanced API Security após a ativação do complemento nos ambientes da Apigee, consulte Visão geral do Advanced API Security.
Disponibilidade
O Advanced API Security está disponível como um recurso de complemento pago gerenciado para cada ambiente da Apigee na implementação da Apigee. O complemento pode ser ativado em qualquer ambiente intermediário ou completo da Apigee. Não é possível ativar e usar a segurança avançada da API em Base ambientes. Para mais detalhes sobre os recursos do ambiente da Apigee, consulte Comparação de tipos de ambiente.
Papéis e permissões necessárias
Para receber as permissões necessárias para gerenciar o complemento do Advanced API Security,
peça ao administrador para conceder a você o
papel de administrador do ambiente da Apigee (apigee.environment.admin)
do IAM no projeto.
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Esse papel predefinido contém as permissões necessárias para gerenciar o complemento Advanced API Security. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:
Permissões necessárias
As permissões abaixo são necessárias para gerenciar o complemento "Advanced API Security":
-
apigee.addonsconfig.get -
apigee.addonsconfig.update
Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.
Depois que o complemento for ativado, poderá ser necessário usar outros papéis para realizar tarefas usando o Advanced API Security. Para mais informações, consulte Papéis necessários.
Ativar o complemento Advanced API Security
É possível ativar o complemento Advanced API Security para um ambiente da Apigee intermediário ou completo usando a API.
Para ativar o complemento Advanced API Security usando a API Apigee, digite o seguinte comando:
curl -X POST \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" \
-d '{"apiSecurityEnabled":true}'Em que:
- ORG_NAME é o nome da organização de pagamento por uso da Apigee em que você quer adicionar o Advanced API Security aos ambientes qualificados.
- ENV_NAME é o nome do ambiente da Apigee em que você quer ativar o complemento Advanced API Security.
Após a conclusão da ativação, clique em Advanced API Security para ver as opções da página de uso dos seus dados de segurança, incluindo Avaliação de risco, Detecção de abuso, Relatórios de segurança e Ações de segurança. Os dados do Advanced API Security podem levar até 10 minutos para aparecer na UI ou ficam disponíveis por uma chamada de API.
O processo de ativação do complemento Advanced API Security pode levar até 15 minutos. Depois de ativados, os dados de análise do ambiente são retidos por 14 meses. É possível acessar os dados históricos do ambiente nas páginas Advanced API Security no console, desde que o complemento esteja ativado.
O faturamento para uso do complemento Advanced API Security começa quando a ativação do complemento é iniciada.
Desativar o complemento Advanced API Security
É possível desativar o complemento do Advanced API Security para um ambiente da Apigee intermediário ou completo usando a API.
Para desativar o complemento Advanced API Security usando a API Apigee, digite o seguinte comando:
curl -X POST \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" \
-d '{"apiSecurityEnabled":false}'Em que:
- ORG_NAME é o nome da organização do Apigee de pagamento por uso em que você quer desativar o Advanced API Security em ambientes qualificados.
- ENV_NAME é o nome do ambiente da Apigee em que você quer desativar o complemento Advanced API Security.
Conferir o status do complemento "Advanced API Security" em um ambiente
É possível verificar o status do complemento Advanced API Security para um ambiente da Apigee intermediário ou completo usando a API.
Para visualizar o status do complemento Advanced API Security em um ambiente usando a API Apigee, digite o seguinte comando:
curl -X GET \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" Em que:
- ORG_NAME é o nome da organização de pagamento por uso da Apigee.
- ENV_NAME é o nome do ambiente da Apigee.
A resposta retorna um objeto ApiSecurityConfig que representa o status atual do complemento.
Gerenciar seus dados da segurança avançada de APIs
Depois que o complemento "Advanced API Security" é ativado em um ambiente, os dados de segurança dele são mantidos por 14 meses. É possível acessar os relatórios de segurança do ambiente na página Relatórios de segurança do console, mas não é possível criar novos relatórios.
Se você desativar o complemento "Advanced API Security" em um ambiente, os dados de segurança dele serão excluídos após 30 dias. Se você reativar o complemento no mesmo ambiente até 30 dias após a desativação, poderá recuperar o acesso aos dados de análise do ambiente durante o período de armazenamento de 14 meses. Nenhum dado será restaurado se o complemento for reativado para o ambiente após 30 dias.
Se você quiser manter os relatórios de segurança de qualquer ambiente após o período de armazenamento de 14 meses, recomendamos exportar e salvar os dados em outro local. Também é possível exportar os dados da Advanced API Security antes de desativar o complemento ou em um período de 30 dias após a desativação. É possível exportar os relatórios de segurança usando o botão Exportar na página Relatórios de segurança do console ou fazer o download de um relatório usando a API Security Reporting.