支持 HTTPS

HTTPS在HTTP的基础上加入了SSL协议,对信息、数据加密,用来保证数据传输的安全。现如今被广泛使用。

API网关支持使用HTTPS对您的API请求进行加密。可以控制到API级别,您可以强制您的API只支持HTTP、HTTPS或者两者均支持。如果您的API需要支持HTTPS,操作流程如下:

步骤1:准备

您需要准备如下材料:

  • 一个自有可控域名。

  • 为这个域名申请一个SSL证书

  • 自定义上传证书,包含证书/私钥,均为 PEM 格式(注:API网关Tengine服务是基于Nginx,因此只支持Nginx能读取的证书,即PEM格式)。

SSL证书会包含两部分内容:XXXXX.key、XXXXX.pem,可以使用文本编辑器打开。示例如下:

KEY:

-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
....
-----END RSA PRIVATE KEY-----

PEM:

-----BEGIN CERTIFICATE-----
MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
...
-----END CERTIFICATE-----	

步骤2:绑定SSL证书

登录API网关控制台,在左侧导航栏选择API 管理 > 分组管理,单击您需要绑定SSL证书的分组,查看分组详情。在绑定SSL证书之前,您首先需要在API分组上绑定独立域名

独立域名处添加SSL证书。

  • 证书名称:用户自定义名称,以供后续识别。

  • 证书内容:证书的完整内容,需要复制XXXXX.pem中的全部内容。

  • 私钥:证书的私钥,需要复制XXXXX.key中的内容。点击确定后,完成SSL证书的绑定。

步骤3:API配置调整

绑定SSL证书后,您可以按API控制不同的访问方式,支持HTTP、HTTPS、HTTP和HTTPS三种,出于安全考虑,建议全部配置成HTTPS。

  1. API网关控制台的左侧导航栏选择API 管理 > API列表找到相应API。

  2. 单击目标API名称,在右上角单击编辑

  3. 进入基本信息,单击下一步,进入定义API请求栏,勾选协议

    image

API支持的协议包括:

  • HTTP:只允许HTTP访问,不允许HTTPS。

  • HTTPS:只允许HTTPS访问,不允许HTTP。

  • HTTP和HTTPS:两者均可,调整后,API支持HTTPS协议配置完成。您的API将支持HTTPS访问。