Faça a gestão do suplemento de segurança avançada da API

Esta página aplica-se ao Apigee, mas não ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

A segurança avançada de APIs monitoriza continuamente as suas APIs para as proteger contra ameaças de segurança, incluindo ataques de clientes maliciosos e abusos. A segurança avançada da API analisa o tráfego da API para identificar pedidos de API suspeitos e fornece ferramentas que podem bloquear ou denunciar esses pedidos. Além disso, a segurança avançada da API avalia as suas configurações de API para garantir que cumprem as normas de segurança e dá-lhe recomendações para as melhorar, se necessário.

Se for cliente do Apigee com pagamento conforme o uso, a segurança avançada de APIs está disponível como um suplemento pago. Este tópico descreve como ativar e gerir o suplemento Advanced API Security para ambientes de pagamento conforme o uso elegíveis. Para mais informações sobre a utilização da segurança avançada de APIs depois de o suplemento ser ativado nos seus ambientes do Apigee, consulte o artigo Vista geral da segurança avançada de APIs.

Disponibilidade

A segurança avançada de APIs está disponível como uma capacidade de suplemento paga que é gerida para cada ambiente do Apigee na sua implementação do Apigee. O suplemento pode ser ativado em qualquer ambiente Intermédio ou Abrangente do Apigee. Não pode ativar nem usar a segurança avançada de APIs em ambientes base. Para mais detalhes sobre as capacidades do ambiente do Apigee, consulte a Comparação de tipos de ambientes.

Funções e autorizações necessárias

Para receber as autorizações de que precisa para gerir o suplemento de segurança avançada da API, peça ao seu administrador para lhe conceder a função de administrador do ambiente do Apigee (apigee.environment.admin) do IAM no projeto. Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Esta função predefinida contém as autorizações necessárias para gerir o suplemento de segurança avançada da API. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:

Autorizações necessárias

São necessárias as seguintes autorizações para gerir o suplemento de segurança avançada da API:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.

Depois de o suplemento ser ativado, podem ser necessárias funções adicionais para realizar tarefas através da segurança avançada da API. Para mais informações, consulte o artigo Funções necessárias.

Ative o suplemento de segurança avançada da API

Pode ativar o suplemento de segurança avançada da API para um ambiente do Apigee intermédio ou abrangente através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Apigee na Google Cloud consola

Para ativar o suplemento de segurança avançada de APIs na Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Segurança avançada da API para abrir a página Suplemento de segurança avançada da API.
  4. No painel Gerir suplemento de segurança da API avançada, selecione a caixa de verificação do ambiente (ou ambientes) onde quer ativar o suplemento.
  5. Clique em Ativar selecionados.
  6. Quando a ativação estiver concluída para os ambientes selecionados, o Estado do ambiente apresenta Ativado.
  7. Selecione Segurança avançada de APIs para ver as opções da página para usar os seus dados de segurança, incluindo Avaliação de riscos, Deteção de abusos, Relatórios de segurança e Ações de segurança. A apresentação dos dados de segurança avançada da API pode demorar até 10 minutos.

API Apigee

Para ativar o suplemento Advanced API Security através da API Apigee, introduza 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}'

Onde:

  • ORG_NAME é o nome da organização do Apigee de pagamento conforme o uso onde quer adicionar a segurança avançada da API a ambientes elegíveis.
  • ENV_NAME é o nome do ambiente do Apigee onde quer ativar o suplemento de segurança avançada da API.

Quando a ativação estiver concluída, clique em Segurança avançada da API para ver as opções da página para usar os seus dados de segurança, incluindo Avaliação de risco, Deteção de abusos, Relatórios de segurança e Ações de segurança. Os dados de segurança avançada da API podem demorar até 10 minutos a serem apresentados na IU ou a ficarem disponíveis através de uma chamada API.

O processo de ativação do suplemento de segurança avançada da API pode demorar até 15 minutos. Depois de ativados, os dados de segurança do ambiente são retidos durante 14 meses. Pode aceder aos dados históricos do ambiente nas páginas de Segurança avançada da API na consola, desde que o suplemento esteja ativado.

A faturação da utilização do suplemento Advanced API Security começa assim que a ativação do suplemento tiver início.

Desative o suplemento de segurança avançada da API

Pode desativar o suplemento de segurança avançada da API para um ambiente do Apigee intermédio ou abrangente através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Apigee na Cloud Console

Para desativar o suplemento de segurança avançada da API na Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Segurança avançada da API para abrir a página Suplemento de segurança avançada da API.
  4. No painel Gerir suplemento de segurança avançada da API, selecione a caixa de verificação do ambiente (ou ambientes) onde quer desativar o suplemento.
  5. Clique em Desativar selecionados.
  6. Quando a desativação estiver concluída, o Estado apresenta Desativado para cada ambiente.

API Apigee

Para desativar o suplemento Advanced API Security através da API Apigee, introduza 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}'

Onde:

  • ORG_NAME é o nome da organização do Apigee de pagamento conforme o uso onde quer desativar a segurança avançada da API em ambientes elegíveis.
  • ENV_NAME é o nome do ambiente do Apigee onde quer desativar o suplemento Advanced API Security.

Veja o estado do suplemento de segurança avançada da API num ambiente

Pode verificar o estado do suplemento de segurança avançada da API para um ambiente do Apigee intermédio ou abrangente através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Apigee na Google Cloud consola

Para ver o estado do suplemento Advanced API Security num ambiente que usa a Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Segurança avançada da API para abrir a página Suplemento de segurança avançada da API.
  4. No painel Gerir suplemento de segurança avançada de APIs, é apresentada uma lista de ambientes.
  5. Na coluna de estado, pode ver se o suplemento está Ativado ou Desativado em cada ambiente intermédio ou abrangente. Os ambientes base não apresentam nenhum dos estados.

API Apigee

Para ver o estado do suplemento Advanced API Security num ambiente que usa a API Apigee, introduza 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"

Onde:

  • ORG_NAME é o nome da organização Apigee de pagamento conforme o uso.
  • ENV_NAME é o nome do ambiente Apigee.

A resposta devolve um objeto ApiSecurityConfig que representa o estado atual do suplemento.

Faça a gestão dos seus dados de segurança avançada da API

Depois de o suplemento Advanced API Security ser ativado para um ambiente, os dados de segurança do ambiente são retidos durante 14 meses. Pode aceder aos relatórios de segurança gerados anteriormente para o ambiente na página Relatórios de segurança na consola, mas não é possível criar novos relatórios.

Se desativar o suplemento Advanced API Security num ambiente, os dados de segurança do ambiente são eliminados após 30 dias. Se reativar o suplemento no mesmo ambiente no prazo de 30 dias após a desativação, pode recuperar o acesso aos dados de segurança do ambiente através do período de retenção de 14 meses. Não são restaurados dados se o suplemento for reativado para o ambiente após 30 dias.

Se quiser reter relatórios de segurança para qualquer ambiente para além do período de retenção de 14 meses, recomendamos que exporte e guarde os seus dados noutra localização. Também pode exportar os dados de segurança da API avançada antes de desativar o suplemento ou no período de 30 dias após a desativação. Pode exportar os seus relatórios de segurança através do botão Exportar na página Relatórios de segurança da consola ou transferir um relatório através da API Security reports.