处理 API 签名

API 签名是一种用于验证请求真实性和完整性的安全机制。本指南演示如何在 Apidog 中自动生成签名，从而无需为每个请求手动获取签名。

签名自动化策略

不要在每次请求前手动访问签名端点，而是使用 Apidog 的脚本功能来：

创建一个实现签名逻辑的公共脚本

使用请求参数自动生成签名

通过脚本或环境变量将签名附加到请求

在 API 预处理器中引用公共脚本

实现方式

方法 1：直接修改脚本

通过脚本直接添加签名参数并修改请求信息，无需使用环境变量。

优点：

无需管理环境变量

参数即时更新

配置更简单

方法 2：环境变量

生成签名并将其写入环境变量，然后在 API 参数中引用该变量。

优点：

可在多个请求中复用

更易于调试和监控

集中化签名管理

方法 3：外部程序

对于使用其他语言实现的签名，请使用 dog.execute 方法调用外部程序。

示例：基于 MD5 的签名

签名生成规则

步骤 1：构建参数字符串

将所有非空参数收集到集合 M 中

按 ASCII 码升序（字典序）对参数排序

以 URL 键值格式拼接参数：key1=value1&key2=value2...

结果：stringA

重要规则：

按 ASCII 码升序对参数名排序

空参数值不参与签名

参数名区分大小写

sign 参数本身不参与签名

步骤 2：生成签名

将 key 拼接到 stringA 的末尾，得到 stringSignTemp

对 stringSignTemp 应用 MD5 算法

将结果转换为大写，得到 signValue

公共脚本实现

示例：翻译 API 签名

签名生成规则

步骤 1：拼接字符串

按顺序拼接以下值：

appid：应用 ID

q：待翻译文本（UTF-8 编码）

salt：随机数

key：平台分配的密钥（可在管理控制台中获取）

结果：appid + q + salt + key

步骤 2：生成签名

对拼接后的字符串应用 MD5 算法，得到 32 位小写签名。

重要说明：

待翻译文本（q）必须使用 UTF-8 编码

拼接 appid+q+salt+key 时，不要对 q 进行 URL 编码

生成签名后，在发送 HTTP 请求前对 q 进行 URL 编码

示例请求

公共脚本实现

最佳实践

实践	描述
使用环境变量	将敏感密钥存储在环境变量中，而不是脚本中
验证参数	在生成签名前检查必需参数
记录日志以便调试	使用 `console.log()` 调试签名生成问题
处理边界情况	考虑空值、特殊字符和编码
集中化逻辑	使用公共脚本避免重复编写签名逻辑
充分测试	使用已知测试用例验证签名生成

签名自动化策略#

实现方式#

方法 1：直接修改脚本#

方法 2：环境变量#

方法 3：外部程序#

示例：基于 MD5 的签名#

签名生成规则#

公共脚本实现#

示例：翻译 API 签名#

签名生成规则#

示例请求#

公共脚本实现#

最佳实践#

签名自动化策略

实现方式

方法 1：直接修改脚本

方法 2：环境变量

方法 3：外部程序

示例：基于 MD5 的签名

签名生成规则

公共脚本实现

示例：翻译 API 签名

签名生成规则

示例请求

公共脚本实现

最佳实践