接口签名如何处理

期望效果

  1. 统一处理，无需每个接口单独处理。

实现思路

  1. 创建一个 公共脚本 实现签名逻辑，读取接口请求参数，然后使用 内置类库，如（crypto-js接口签名如何处理 - 图1），生成签名。
  2. 将生成的签名 sign 作为参数加入请求，可使用以下两种方案：
    • 方案一：脚本直接修改请求信息，注入一个签名参数，无需使用环境变量。
    • 方案二：将生成的签名写入环境变量，接口设置参数时引用环境变量。
  3. 在接口的 前置脚本 里引用前面创建公共脚本。
  4. 如果签名算法是其他语言编写的，可使用fox.execute方法 调用其他语言编写的程序

接口签名示例

签名生成规则

本签名规则同 微信支付签名算法接口签名如何处理 - 图2。

第一步：假设所有发送参数集合M，将集合M内非空参数值的参数按照参数名 ASCII 码从小到大排序（字典序），使用 URL 键值对的格式（即key1=value1&key2=value2…）拼接成字符串stringA。

特别注意以下重要规则：

  1. 参数名ASCII码从小到大排序（字典序）；
  2. 如果参数的值为空不参与签名；
  3. 参数名区分大小写；
  4. 传送的sign参数不参与签名；

第二步：在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。

公共脚本实现

  1. // 获取预先设置为环境变量的 APPKEY
  2. let key = pm.environment.get("APPKEY");
  4. // 存放所有需要用来签名的参数
  5. let param = {};
  7. // 加入 query 参数
  8. let queryParams = pm.request.url.query;
  9. queryParams.each(item => {
  10.     if (!item.disabled && item.value !== '') { // 启用且非空参数值的参数才参与签名
  11.         param[item.key] = item.value;
  12.     }
  13. });
  15. // 加入 body 参数
  16. if (pm.request.body) {
  17.     let formData;
  18.     switch (pm.request.body.mode) {
  19.         case 'formdata':
  20.             formData = pm.request.body.formdata;
  21.             break;
  22.         case 'urlencoded':
  23.             formData = pm.request.body.urlencoded;
  24.             break;
  25.         case 'raw':
  26.             // 如果没有 JSON 格式的请求 body，或 JSON 格式 body 不参与签名，可以删除这一段
  27.             let contentType = pm.request.headers.get('content-type');
  28.             if (
  29.                 contentType
  30.                 && pm.request.body.raw
  31.                 && contentType.toLowerCase().indexOf('application/json') !== -1
  32.             ) {
  33.                 try {
  34.                     let jsonData = JSON.parse(pm.request.body.raw);
  35.                       /*
  36.                       * 注意：通过脚本取出来的接口参数，如果参数包含变量，变量是不会替换成对应的值。如想要获取替换后的值，可使用`pm.variables.replaceIn`方法处理：
  37.                     * let body = pm.variables.replaceIn(pm.request.body.raw);
  38.                     * let jsonData = JSON.parse(body);
  39.                       */
  40.                     for (let key in jsonData) {
  41.                         let value = `${jsonData[key]}`; // 此处要注意如果值的实际类型不是 string 需要根据实际情况处理。
  42.                         if (value !== '') { // 非空参数值的参数才参与签名
  43.                             param[key] = value;
  44.                         }
  45.                     }
  46.                 } catch (e) {
  47.                     console.log('请求 body 不是 JSON 格式')
  48.                 }
  49.             }
  50.             break;
  51.         default:
  52.             break;
  53.     }
  54.     if (formData) {
  55.         formData.each(item => {
  56.             if (!item.disabled && item.value !== '') { // 启用且非空参数值的参数才参与签名
  57.                 param[item.key] = item.value;
  58.             }
  59.         });
  60.     }
  61. }
  64. // 取 key
  65. let keys = [];
  66. for (let key in param) {
  67.     // 注意这里，要剔除掉 sign 参数本身
  68.     if (key !== 'sign') {
  69.         keys.push(key);
  70.     }
  71. }
  73. // 参数名 ASCII 码从小到大排序（字典序）
  74. keys.sort();
  76. // 转成键值对
  77. let paramPair = [];
  78. for (let i = 0, len = keys.length; i < len; i++) {
  79.     let k = keys[i];
  80.     paramPair.push(k + '=' + encodeURIComponent(param[k])) // urlencode 编码
  81. }
  83. // 最后加上 key
  84. paramPair.push("key=" + key);
  86. // 拼接
  87. let stringSignTemp = paramPair.join('&');
  88. // console.log(stringSignTemp);
  90. let sign = CryptoJS.MD5(stringSignTemp).toString().toUpperCase();
  91. // console.log(sign);
  93. // 方案一：直接修改接口请求的 query 参数，注入 sign，无需使用环境变量。
  94. // 参考文档：https://www.apifox.cn/help/app/scripts/examples/request-handle/
  95. queryParams.upsert({
  96.     key: 'sign',
  97.     value: sign,
  98. });
  100. // 方案二：写入环境变量，此方案需要在接口里设置参数引用环境变量
  101. // pm.environment.set("SIGN", sign);

百度翻译接口签名示例

本示例为调用百度翻译接口，百度翻译接口参考文档接口签名如何处理 - 图3。

签名生成规则

第一步：将请求参数中的 APPID(appid)， 翻译query(q, 注意为UTF-8编码), 随机数(salt), 以及平台分配的密钥(可在管理控制台接口签名如何处理 - 图4查看) 按照 appid+q+salt+密钥 的顺序拼接得到字符串1。 第二步：对字符串1做md5，得到32位小写的sign。

注：

  1. 待翻译文本（q）需为UTF-8编码
  2. 在生成签名拼接 appid+q+salt+密钥 字符串时，q不需要做URL encode，在生成签名之后，发送HTTP请求之前才需要对要发送的待翻译文本字段q做URL encode
  1. 官方举例：将apple从英文翻译成中文：
  2. 请求参数：
  3. q=apple
  4. from=en
  5. to=zh
  6. appid=2015063000000001
  7. salt=1435660288
  8. 平台分配的密钥: 12345678
  9. 生成sign：
  10. >拼接字符串1
  11. 拼接appid=2015063000000001+q=apple+salt=1435660288+密钥=12345678
  12. 得到字符串1 =2015063000000001apple143566028812345678
  13. >计算签名sign（对字符串1做md5加密，注意计算md5之前，串1必须为UTF-8编码）
  14. sign=md5(2015063000000001apple143566028812345678)
  15. sign=f89f9594663708c1605f3d736d01d2d4
  16. 完整请求为：
  17. http://api.fanyi.baidu.com/api/trans/vip/translate?q=apple&from=en&to=zh&appid=2015063000000001&salt=1435660288&sign=f89f9594663708c1605f3d736d01d2d4

公共脚本实现

  1. // 获取 Query 参数对象
  2. var queryParams = pm.request.url.query;
  4. // 获取 query 参数 q 的值
  5. var q = queryParams.get('q');
  7. // 获取预先设置为环境变量的 APPID 和 SECRET_KEY
  8. var appid = pm.environment.get("APPID");
  9. var secretKey = pm.environment.get("SECRET_KEY");
  11. // 定义一个随机数（32768, 65536）之间
  12. var salt = parseInt(Math.random() * (32769) + 32768, 10);
  14. // 将随机数转换为字符串
  15. salt = salt.toString();
  16. console.log(salt);
  18. // 定义一个由appid、要翻译的字符串、随机数、密钥组合成一个字符串
  19. var str = appid + q + salt + secretKey;
  20. console.log(str);
  22. // 将 str 进行 md5 加密生成 sign
  23. var sign = CryptoJS.MD5(str).toString();
  25. // 方案一：直接修改接口请求的 query 参数，注入 salt 和 sign，无需使用环境变量。
  26. // 参考文档：https://www.apifox.cn/help/app/scripts/examples/request-handle/
  27. queryParams.upsert({
  28.     key: 'salt',
  29.     value: salt,
  30. });
  31. queryParams.upsert({
  32.     key: 'sign',
  33.     value: sign,
  34. });