O HTTPS adiciona uma camada de segurança ao protocolo HTTP padrão usando o Secure Sockets Layer (SSL) para criptografar dados, garantindo a segurança das informações em trânsito.
O API Gateway permite proteger requisições de API com HTTPS. Configure cada API para suportar apenas HTTP, apenas HTTPS ou ambos. Para ative o HTTPS na sua API, siga estas etapas.
Etapa 1: Pré-requisitos
Antes de começar, verifique se você possui os seguintes itens:
Um nome de domínio independente sob sua posse e controle.
Um certificado SSL para o nome de domínio.
Um certificado SSL e sua chave privada, ambos no formato PEM. Observação: O API Gateway usa o Tengine, serviço baseado em Nginx, e exige certificados compatíveis com Nginx no formato PEM.
Geralmente, o certificado SSL e a chave privada são fornecidos em dois arquivos, como XXXXX.pem e XXXXX.key. Abra ambos com um editor de texto.
CHAVE:
-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
....
-----END RSA PRIVATE KEY-----PEM:
-----BEGIN CERTIFICATE-----
MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
...
-----END CERTIFICATE----- Etapa 2: Vincular certificado SSL
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha . Clique em no nome do grupo de APIs ao qual deseja vincular o certificado SSL. Antes de vincular um certificado SSL, vincule primeiro um independent domain name ao grupo de APIs.
Na linha correspondente ao nome de domínio, clique em Select Certificate na coluna SSL Certificate.
Adicione um certificado SSL para o Independent Domain Name.
O nome do certificado pode conter caracteres chineses, letras, dígitos, sublinhados (_) e hifens (-). Ele deve começar com uma letra ou caractere chinês e ter entre 4 e 50 caracteres. O conteúdo do certificado e a chave privada devem estar codificados em PEM e não podem exceder 20 KB. Clique em no botão Upload para importar os arquivos. Para autenticação mútua HTTPS, clique em no link Click to add CA certificate para adicionar um certificado de CA.
Certificate Name: Nome personalizado para facilitar a identificação do certificado.
Certificate Content: Conteúdo completo do arquivo de certificado XXXXX.pem.
Private Key: Conteúdo do arquivo de chave privada XXXXX.key. Clique em OK para vincular o certificado.
Etapa 3: Ajustar configuração da API
Após vincular o certificado SSL, controle o protocolo de acesso de cada API. Os protocolos suportados são HTTP, HTTPS ou ambos. Por motivos de segurança, recomendamos configurar todas as APIs para usar HTTPS.
No console do API Gateway, acesse e localize a API desejada.
Clique em no nome da API desejada e, em seguida, clique em Edit no canto superior direito.
-
Na etapa Basic Information, clique em Next para prosseguir para a etapa Define API Request. Na seção Protocol, selecione os protocolos desejados.
Selecione HTTP e HTTPS.
Valores válidos para Protocol:
HTTP: Permite acesso à API apenas via HTTP e nega acesso via HTTPS.
HTTPS: Permite acesso à API apenas via HTTPS e nega acesso via HTTP.
HTTP e HTTPS: Permite acesso à API por ambos os protocolos, habilitando o acesso HTTPS para sua API.