Todos os produtos
Search
Central de documentação

API Gateway:Gerenciar consumidores

Última atualização: Jun 27, 2026

O Cloud-native API Gateway usa consumidores para ative a autenticação em rotas e APIs. No console, você pode crie, desativar e exclua consumidores.

Crie um consumidor

O Cloud-native API Gateway oferece três métodos de autenticação.

Método

Descrição

Quando usar

Chave de API

O cliente adiciona uma credencial à solicitação. O gateway valida a legitimidade e as permissões. Menos seguro que JWT ou AK/SK. Proteja suas credenciais com cuidado.

Cenários leves e de integração rápida, com baixos requisitos de segurança.

JWT

Padrão para transmissão segura de informações entre cliente e servidor usando assinaturas HMAC, RSA ou ECDSA. Use o JWT para verificação de identidade e controle de acesso no gateway.

Sistemas distribuídos e cenários de SSO.

HMAC

O cliente usa um par AK/SK para assinar o conteúdo da solicitação com o algoritmo HMAC e envia a assinatura ao gateway para validação.

Cenários que exigem alta integridade de dados e proteção contra adulteração.

Crie um consumidor com autenticação por chave de API

  1. Acesse a página Consumers no console do Cloud-native API Gateway e selecione uma região.

  2. Clique em Create a consumer. No painel Create Consumer, defina o Consumer Name, selecione API Key como método de autenticação e conclua as configurações a seguir:

    • Generation Method:

      • System Generated: O sistema gera automaticamente uma chave de API.

      • Custom: Especifique uma chave de API personalizada e sua source.

    • Credential: A chave de API personalizada.

    • Credential Source:

      Local na solicitação de onde o gateway obtém a chave de API:

      • Authorization: Bearer <token> (Formato de token padrão)

      • Custom HTTP Header (como X-API-Key: your-key)

      • Custom Query Parameter (como ?apikey=your-key)

Crie um consumidor com autenticação JWT

  1. Acesse a página Consumers no console do Cloud-native API Gateway e selecione uma região.

  2. Clique em Create a consumer. No painel Create Consumer, defina o Consumer Name, selecione JSON Web Token (JWT) como método de autenticação e conclua as configurações a seguir:

    • Creation Method:

      • Local Configuration: Use quando o serviço de autenticação e o gateway estiverem no mesmo cluster ou LAN, os requisitos de desempenho forem altos e as chaves mudarem com pouca frequência.

      • Remote Fetch: Ideal para uso com um centro de identidade unificado, como OAuth2 ou OpenID Connect. Suporta atualizações dinâmicas de chave. Recomendado para ambientes multilocatário ou de produção.

    • Key Type (não obrigatório para Remote Fetch):

      • Symmetric Key: Gera uma configuração JWKS padrão exclusiva para cada consumidor, contendo a chave para criptografia e descriptografia do token.

      • Asymmetric Key: Forneça uma configuração JWKS completa e use uma chave privada para criptografar o token. O gateway descriptografa o token com a chave pública presente no JWKS.

    • JWKS:

      • Se selecione Local Configuration, configure o JWKS conforme a especificação JSON Web Key (JWK).

      • Se selecione Remote Fetch, insira a URL. O sistema analisa automaticamente o número da porta, o tempo limite e a duração do cache a partir da URL.

        Importante

        A URL deve ser um nome de domínio, não um endereço IP.

    • JWT Token: Defina a configuração do token JWT.

      • Type: Tipo do parâmetro de token. O padrão é Header.

      • Key: Nome do parâmetro de token.

      • Prefix: Prefixo do parâmetro de token. O padrão é o cabeçalho Authorization com o prefixo Bearer, por exemplo, Authorization: Bearer token.

      • Enable Passthrough: Encaminha o parâmetro de token para o serviço de backend.

    • Consumer ID in JWT Payload: Par chave-valor no payload do JWT que identifica o consumidor. O padrão é uid com uma string aleatória como valor. Personalizável. Exemplo de payload:

      {
        "uid": "11215ac069234abcb8944232b79ae711"
      }

Crie um consumidor com autenticação HMAC

  1. Acesse a página Consumers no console do Cloud-native API Gateway e selecione uma região.

  2. Clique em Create a consumer. No painel Create Consumer, defina o Consumer Name, selecione Hash-based Message Authentication Code (HMAC) como método de autenticação e conclua as configurações a seguir:

    • System Generated: O sistema gera automaticamente a Access Key (AK) e a Secret Key (SK).

    • Custom: Especifique uma AK e SK personalizadas.

Desativar um consumidor

  1. Faça login no console do API Gateway.

  2. No painel de navegação à esquerda, clique em Consumers. Na barra de navegação superior, selecione uma região.

  3. Na página Consumers, localize o consumidor desejado, clique em Disable na coluna Actions e clique em OK para confirme.

Exclua um consumidor

  1. Faça login no console do API Gateway.

  2. No painel de navegação à esquerda, clique em Consumers. Na barra de navegação superior, selecione uma região.

  3. Na página Consumers, localize o consumidor desejado e clique em Delete na coluna Actions. Na caixa de diálogo de confirmação, insira o nome do consumidor e clique em Delete.