目录

获取授权链接 (deprecated)

此接口即将废弃,建议使用获取时效性授权链接替代。

功能介绍

此接口用于直接获取授权链接。服务商可以在自己的管理网站上展示此链接,并引导商家点击链接跳转到授权页面,商家选择要授权的元服务,点击确定即可完成授权。

接口原型

承载协议

HTTPS POST

接口方向

服务商服务器 -> 华为服务器

接口URL

https://connect-api.cloud.huawei.com/api/auth/v1/get-authorization-link

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

[h2]Header

参数

必选(M)/可选(O)

类型

说明

client_id

M

String

API客户端ID。

创建第三方平台成功后系统自动分配的客户端ID,可在第三方管理平台“开发配置 > 开发资料设置”页面中获取,详情请参见获取平台访问凭据。

Authorization

M

String

认证信息。

格式为“Authorization: Bearer ${access_token}”。

其中,${access_token}为获取平台级Token中获取的access_token。

[h2]Body

参数

必选(M)/可选(O)

类型

说明

type

O

Integer

授权链接类型。

取值范围:

  • 0:新增元服务授权
  • 1:已有元服务授权
  • 2:修改授权

不传默认为0。

redirectUri

O

String

跳转链接,域名必须与创建三方平台时设置的授权回调域名一致。

authList

O

List<String>

对应第三方平台配置的scope列表, 默认为所使用第三方平台配置的全部权限。

  • 应用基本信息管理:"saas.app.basicinfo.manage"
  • 应用开发与发布管理: "saas.app.version.manage"
  • 服务集成与开发:"saas.app.dev"
  • 运营管理:"saas.app.operation"
  • 应用备案:"saas.app.icp.manage"

第三方管理平台权限描述及说明详情请参见权限集说明。

appId

O

String

元服务或HarmonyOS应用的appId,type=2时,必填。

请求示例

{
  "type": 0,
  "redirectUri": "https://sample.com",
  "authList": ["saas.app.basicinfo.manage","saas.app.version.manage","saas.app.dev","saas.app.operation"],
  "appId": "112****3"
}

响应参数

参数

类型

说明

ret

CodeAndMsg

包含返回码及描述信息。

返回码详情请参见错误码。

link

String

返回的授权链接。

CodeAndMsg

参数

类型

说明

code

Integer

返回码。

msg

String

返回码描述信息。

响应示例

{
    "ret": {
        "code": 0,
        "msg": "success"
    },
    "link": "https://****.html#/authorization?clientId=1117****6944&type=0"
}

其他说明

商家权限变更通知回调

当授权链接携带“redirectUri”参数时,商家授权完成后会将授权元服务的“appId”字段拼接至传入的“redirectUri”后,网页跳转链接示例:https://sample.com?appId=112****3。

用于当商家确认授权、更新授权或取消授权时,华为服务器会向服务商在第三方管理平台配置的消息与事件接收URL(创建第三方平台时填写)以 POST 的方式推送相关通知。

为了加强安全性,华为服务器在发送通知时对Body体中的参数使用SHA256WithRSA/PSS算法进行了签名,并在signatureRSAWithPSS中返回签名后的字符串。您需要使用消息与事件接收信息中获取的验签公钥对签名字符串进行验签,验签方法参见验签示例。

如果服务商需要华为服务器推送消息返回一些业务自定义信息,可在获取授权链接接口的响应link后拼接“traceInfo”字段,字段内容需要进行URL编码,示例:https://****.html#/authorization?clientId=1117****6944&type=0&traceInfo=xxxx

承载协议

HTTPS POST

接口方向

华为服务器 -> 服务商服务器

接口URL

第三方管理平台上配置的华为服务器回调服务商服务器的回调域名(“回调URL”),您需自行保证地址为https开头的合法URL地址,具体请参见消息与事件接收URL。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

[h2]Header

参数

必选(M)/可选(O)

类型

描述

notifyType

M

String(32)

回调类型,固定为“spPermissionChange”。

signatureRSAWithPSS

M

String

华为服务器在发送通知时对Body体中的参数使用SHA256WithRSA/PSS算法进行了签名,并在signatureRSAWithPSS中返回签名后的字符串。

您需要使用消息与事件接收信息中获取的验签公钥对签名字符串进行验签,验签方法参见验签示例。

[h2]Body

参数

必选(M)/可选(O)

类型

说明

infoType

O

String

权限变更类型。

  • authorized:新增授权
  • unauthorized:取消授权
  • updateauthorized:更新授权

recordList

O

ResourceScope[]

资源级权限。

traceInfo

O

String(2048)

授权链接传入字段,由服务商自定义内容。

ResourceScope

参数

必选(M)/可选(O)

类型

说明

type

O

Integer

资源类型。

取值范围:

  • 0:应用
  • 1:项目

resourceId

O

String

资源ID。

  • 如果“type”字段为“0”,则此字段表示应用ID。
  • 如果“type”字段为“1”,则此字段表示项目ID。

scopeList

O

String

资源权限集。

请求示例

{ 
  "infoType": "authorized", 
  "recordList": [ 
    { 
      "type": 0, 
      "resourceId": "66****2", 
      "scopeList": [ 
        "string" 
      ] 
    } 
  ] 
  "traceInfo": "****"
}

响应参数

服务商收到第三方管理平台服务端的POST请求后,需返回HTTP状态码200,标识回调成功。如果服务端认为推送消息失败平台将会进行多次重试(共3次)。

验签示例

/* 
@content 待验签字符串,传入callBackData中携带的JSON字符串 
@sign  签名字符串 
*/ 
private static void verifySignature(String content, String sign) {
    try{
        String pubKey = "消息验证公钥";     //替换为您在第三方管理平台中实际的消息验证公钥。 
        X509EncodedKeySpec x509EncodedKeySpec = new X509EncodedKeySpec(Base64.decodeBase64(pubKey));
        KeyFactory keyFactory = KeyFactory.getInstance("RSA");
        PublicKey publicKey = keyFactory.generatePublic(x509EncodedKeySpec);
        Signature signature = Signature.getInstance("SHA256WithRSA/PSS");
        signature.initVerify(publicKey);
        signature.update(content.getBytes(Charset.forName("UTF-8")));
        if(!signature.verify(Base64.decodeBase64(sign))) {
            throw new ConnectException(EnumReturnCode.INVALID_PARAMETER, "Failed to verifySignature");
        }
    } catch(NoSuchAlgorithmException | SignatureException | InvalidKeyException | InvalidKeySpecException e) {
        LOG.error("verify signature failed", e);
        throw new ConnectException(EnumReturnCode.INVALID_PARAMETER, "Failed to verifySignature");
    } catch(Exception e) {
        LOG.error("verify signature failed", e);
        throw new ConnectException(EnumReturnCode.INVALID_PARAMETER, "Failed to verifySignature");
    }
}