平安云 - 云以致用智造未来

公共请求地址和处理

请求地址 <table border="1" cellpadding="0" cellspacing="0" style="width:811px"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top; width:155px"> 环境 </td> <td style="background-color:#ededed; vertical-align:top; width:288px"> HTTP </td> <td style="background-color:#ededed; vertical-align:top; width:360px"> HTTPS </td> </tr> <tr> <td style="vertical-align:top; width:155px"> 生产 </td> <td style="vertical-align:top; width:288px"> http://apigw.yun.pingan.com/rest/{type} </td> <td style="vertical-align:top; width:360px"> https://apigw.yun.pingan.com/rest/{type} </td> </tr> <tr> <td style="vertical-align:top; width:155px"> 测试 </td> <td style="vertical-align:top; width:288px"> http://10.25.82.49:8080/rest/{type} </td> <td style="vertical-align:top; width:360px"> https://10.25.82.49:8080/rest/{type} </td> </tr> </tbody> </table>   公共请求参数（系统级Header） <table border="1" cellpadding="0" cellspacing="0" style="width:809px"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top; width:188px"> 名称 </td> <td style="background-color:#ededed; vertical-align:top; width:92px"> 类型 </td> <td style="background-color:#ededed; vertical-align:top; width:88px"> 默认 </td> <td style="background-color:#ededed; vertical-align:top; width:127px"> 示例值 </td> <td style="background-color:#ededed; vertical-align:top; width:305px"> 说明 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-AppId </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 必填 </td> <td style="vertical-align:top; width:127px"> 123 </td> <td style="vertical-align:top; width:305px"> 应用编号，在消息云平台申请的应用编号 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-Signature </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 必填 </td> <td style="vertical-align:top; width:127px"> 20170315120000 </td> <td style="vertical-align:top; width:305px"> 签名字符串 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-Timestamp </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 必填 </td> <td style="vertical-align:top; width:127px">   </td> <td style="vertical-align:top; width:305px"> API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟。 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-GroupId </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 必选 </td> <td style="vertical-align:top; width:127px"> 123456 </td> <td style="vertical-align:top; width:305px"> 分组ID，可通过API网关控制-分组管理-分组详情获取 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-RequestId </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 可选 </td> <td style="vertical-align:top; width:127px"> 1.0 </td> <td style="vertical-align:top; width:305px"> API 调用者生成的请求 ID，结合时间戳防重放，若不存在则网关会生成格式为 AG-%{UUID}的请求 ID ，其中 %{UUID} 为网关生成的 UUID，当出现请求异常时返回给调用者，方便排查异常。 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-Signature-Headers </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 可选 </td> <td style="vertical-align:top; width:127px">   </td> <td style="vertical-align:top; width:305px"> 参与校验的其他请求头，格式为 header1,header2...headerN ， header之间可以存在空格，分隔符为英文逗号 , 。 </td> </tr> <tr> <td style="vertical-align:top; width:188px"> PA-AG-Env </td> <td style="vertical-align:top; width:92px"> String </td> <td style="vertical-align:top; width:88px"> 可选 </td> <td style="vertical-align:top; width:127px">   </td> <td style="vertical-align:top; width:305px"> 请求API的发布环境名称。如果不传该值，则默认请求release环境的API </td> </tr> </tbody> </table>   公共响应参数 <table border="1" cellpadding="0" cellspacing="0" style="width:811px"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top; width:139px"> 名称 </td> <td style="background-color:#ededed; vertical-align:top; width:141px"> 类型 </td> <td style="background-color:#ededed; vertical-align:top; width:213px"> 示例 </td> <td style="background-color:#ededed; vertical-align:top; width:308px"> 说明 </td> </tr> <tr> <td style="vertical-align:top; width:139px"> code </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px"> 000000 </td> <td style="vertical-align:top; width:308px"> 返回码，如果返回非000000，则表明请求异常，用户可根据需求进行异常处理。 </td> </tr> <tr> <td style="vertical-align:top; width:139px"> msg </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px"> 成功 </td> <td style="vertical-align:top; width:308px"> 返回信息描述 </td> </tr> <tr> <td style="vertical-align:top; width:139px"> appid </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px">   </td> <td style="vertical-align:top; width:308px"> 应用编号 </td> </tr> <tr> <td style="vertical-align:top; width:139px"> extend </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px">   </td> <td style="vertical-align:top; width:308px"> 公共回传参数 </td> </tr> <tr> <td style="vertical-align:top; width:139px"> expiretime </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px"> 20170315123000 </td> <td style="vertical-align:top; width:308px"> 签名过期时间 yyyyMMddHHmmss </td> </tr> <tr> <td style="vertical-align:top; width:139px"> token </td> <td style="vertical-align:top; width:141px"> String </td> <td style="vertical-align:top; width:213px">   </td> <td style="vertical-align:top; width:308px"> 新的签名 </td> </tr> </tbody> </table>   <ul> <li>请求签名计算说明</li> </ul> 请求签名，是基于请求内容计算的数字签名，用于API识别用户身份。客户端调用API时，需要在请求中添加计算的签名（PA-AG-Signature）。 <ul> <li>签名计算流程</li> </ul> <table border="1" cellpadding="1" cellspacing="1" style="width:812px"> <tbody> <tr> <td style="background-color:#ededed; width:804px"> 准备App > 构造待签名字符串stringToSign > 使用Secret计算签名 > 传递签名 ##### 1.准备APP App，调用API的身份标识，可以到平安云<a href="https://yun.pingan.com/console/apiGateway/app">API网关控制台</a>申请 ##### 2.构造待签名字符串stringToSign String strToSign = HttpMethod + URI + Headers + ContentDigest #### HttpMethod 请求方法，格式为大写，如`GET`，`POST` #### URI `URI` 指 `Path + Query`，组织方法：对 `Query` 参数按照字典对 `Key` **按照字典排序**后按照如下方法拼接，如果 `Query` 参数为空，则 `URL = Path`，不需要添加 `？`，如果某个参数的 `Value` 为空只保留 `Key` 参与签名，等号`=`不需要再加入签名。 ```java String url = Path +"?" +Key1 + "=" + Value1 +"&" + Key2 + "=" + Value2 +..."&" + KeyN + "=" + ValueN `Query` 的 `Key` 和 `Value` 是还未进行 `Encoding` 的原数据，关于 `Encoding` 详见[RFC3986](https://tools.ietf.org/html/rfc3986#section-2.1)。参数的 `Value` 可能有多个，多个的时候根据 `Value` 的**字典顺序**进行排序参与签名计算。 示例：`String url = "/some/path.html?key1=value1&key2=value2&key2=value3&key3"` #### Headers Headers 是指参与签名计算的请求头的 `Key`、`Value` 拼接的字符串。参与签名计算的请求头包括 `PA-AG-Timestamp` 以及 `PA-AG-Signature-Headers` 中填写的需要校验的其他请求头。请求头大小写**不敏感**。 ##### Headers拼接方式 先对参与签名计算的 `Header` 的 `Key` **按照字典排序**后使用如下方式拼接，如果某个 `Header` 的 `Value` 为空，则使用 `HeaderKey.toLowercase() + ":"` 参与签名，需要保留 `Key` 和英文冒号 `：`，并且 `Key` 和 `Value` 左右两边不能有空白字符。`Header`的 `Value` 可能有多个，多个的时候根据 `Value` 的**字典顺序**进行排序参与签名计算。 String headers = HeaderKey1.toLowercase() + ":" + HeaderValue1.toLowercase() + "\n"\+ HeaderKey2.toLowercase() + ":" + HeaderValue2.toLowercase() + "\n"\+ ... HeaderKeyN.toLowercase() + ":" + HeaderValueN.toLowercase() + "\n" #### Content-Digest `Content-Digest` 是指 Body 的 `MD5` 值，只有当请求Body存在时才需要进行计算，计算方式为： String contentDigest = Base64.encodeBase64(MD5(requestBody.getbytes("UTF-8"))); ### 计算签名 Mac hmacSha256 = Mac.getInstance("HmacSHA256"); byte[] keyBytes = secret.getBytes("UTF-8"); hmacSha256.init(new SecretKeySpec(keyBytes, 0, keyBytes.length, "HmacSHA256")); String sign = new String(Base64.encodeBase64(hmacSha256.doFinal(strToSign.getBytes("UTF-8")),"UTF-8")); `secret `为App的密钥。*注：签名算法为创建api时选择的签名算法类型，目前支持 **HmacSHA1** 和 **HmacSHA256** 两种。 **3.传递签名** 将计算的签名结果放到 Request 的 Header 中，Key为PA-AG-Signature </td> </tr> </tbody> </table> 说明：获取更多信息，可参考<a href="https://yun.pingan.com/ssr/help/middleware/APIGateway/DevelopmentFile">API网关</a>。

以上内容是否解决了您的问题？是否