全部产品
Search
文档中心

支持 HTTPS

更新时间: 2018-08-17

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

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

    PEM

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

步骤2:绑定SSL证书

准备好以上材料,需要进行如下操作进行,登陆 API 网关管理控制台【开放API】-【分组管理】,单击您需要绑定 SSL 证书的分组,查看分组详情。

在绑定 SSL 证书,您首先需要在 API 分组上绑定【独立域名】。绑定SSL证书

【独立域名】-添加 SSL 证书。

SSL

  • 证书名称:用户自定义名称,以供后续识别。
  • 证书内容:证书的完整内容,需要复制 XXXXX.pem 中的全部内容。
  • 私钥:证书的私钥,需要复制 XXXXX.key 中的内容。点击【确定】后,完成 SSL 证书的绑定。

    步骤3:API配置调整

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

API配置

可以在【开放API】-【API列表】找到相应 API,【API定义】-编辑-【请求基础定义】中进行修改。

API支持的协议包括:

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

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

  • HTTP 和 HTTPS:两者均可。

    调整后,API 支持 HTTPS 协议配置完成。您的 API 将支持 HTTPS 访问。