概述

概述

注： 该功能仅适用于私有部署版本中使用。

openAPI 通过使用 ak/sk 加密方式，实现接口的权限认证与信息的加密传输，用户在使用 openAPI 时需要先在页面获取 ak/sk 信息，然后通过加密算法生成签名信息，然后将签名信息及其它必要信息添加在请求头中进行接口的请求， 具体包含的信息会在下方介绍。

加密参考文档

签名算法参考文档

在线签名计算工具

通过在「系统设置 -> 空间 Access Key -> openAPI」页面可以添加空间的 ak/sk 信息，用于访问空间相关接口时的认证:

通过在「组织管理 -> 组织 Access Key」页面可以添加组织的 ak/sk 信息，用于访问组织相关接口时的认证:

接口介绍

如何获取 groupKey 和{__scp__}信息

接口中出现的{groupKey}和{__scp__}信息时，可以在页面中进行获取：

请求头信息

请求头中需要包括经过加密计算后的签名信息、时间戳、签名有效期(秒)以及其它需要加密的信息：

{
  authorization: "bce-auth-v1/2ae02d95ec43472e9bc392afc36d195e/2020-09-21T07:11:05Z/36000/host;x-bce-date/3772d4a77f2a45f7ec47cb9d18919b7a09ed22f7e4392060ab6c92b7d762cdab",
  host: {sugarhost},
  "x-bce-date": "2020-09-21T07:11:05Z",
  "Content-Type": "application/json"
}

注：host 等信息需要与所在私有化版本信息一致

参考示例

签名计算通过访问在线签名计算工具，根据信息计算出 openAPI 需要的签名，具体可以参考下图：

POSTMAN 示例请求如下图：

不同接口格式请参考具体页面接口详情描述。

注: openAPI 现在有 V1 和 V2 两个版本，它们接口签名计算方法一致，V2 版本中简化了接口传递参数，无需在 url 中传递{__scp__}参数，groupKey 和{__scp__}的说明和获取可以在上方文档中进行查看。