edit-icon download-icon

To Support HTTPS

Last Updated: Dec 18, 2017

HTTPS is a protocol integrating HTTP and SSL. It encrypts information and data to guarantee data transmission security. HTTPS is widely used today.

The API gateway also supports HTTPS to encrypt your API requests. The encryption can be API-level, that is, you can configure your APIs to support only HTTP or HTTPS or support both of them.

If you require the APIs to support HTTPS, follow these steps:

Step 1. Prepare materials

Prepare the following materials:

  • A self-owned controllable domain name
  • An SSL certificate applied for this domain name

The SSL certificate contains XXXXX.key and XXXXX.pem, which can be opened using the text editor.

Example:

KEY

  1. -----BEGIN RSA PRIVATE KEY-----
  2. MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
  3. ....
  4. -----END RSA PRIVATE KEY-----

PEM

  1. -----BEGIN CERTIFICATE-----
  2. MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
  3. ...
  4. -----END CERTIFICATE-----

Step 2: Bind the SSL certificate

After preparing the preceding materials, log on to the API gateway console and click Open API > Group Management. Click the group to which the SSL certificate is to be bound and check the group details.

Before binding the SSL certificate, bind an Independent domain name to the API group.

1

Independent domain name - Add an SSL certificate.

2

  • Certificate name: Indicates the custom name for further identification.
  • Certificate content: Indicates the complete content of the certificate. You must copy all content in XXXXX.pem.
  • Private key: Indicates the private key of the certificate. You must copy the content in XXXXX.key.

Click OK to complete binding of the SSL certificate.

Step 3: Adjust the API configuration

After binding the SSL certificate, you can enable access over HTTP, HTTPS, or HTTP and HTTPS for APIs. For security considerations, we recommend that you configure all APIs to support access over HTTPS.

3

You can select Open API > API list to locate the corresponding API and click API definition > Edit > Basic request definition to modify the API.

The API supports the following protocols:

  • HTTP: The API only supports access over HTTP.
  • HTTPS: The API only supports access over HTTPS.
  • HTTP and HTTPS: The API supports access over both HTTP and HTTPS.

After the adjustment, the API configuration is complete. Your API supports access over HTTPS.

Thank you! We've received your feedback.