一、简介 企业签名集成API文档旨在为企业用户提供一套完整的API接口,帮助企业快速集成企业签名功能。 本文档详细介绍了API接口的使用方法、参数说明、返回结果以及注意事项等。 二、API接口说明 1. 接口地址:https://api.yourcompany.com/signature 2. 请求方式:POST 3. 请求参数: (1)app_id:应用ID,由企业管理员在平台创建应用时获得。
(2)app_key:应用密钥,由企业管理员在平台创建应用时获得。 (3)timestamp:请求时间戳,格式为“YYYYMMDDHHMMSS”。 (4)sign:签名值,使用企业密钥对以上参数进行签名,签名算法为HMAC-SHA256。
(5)data:请求的业务数据,JSON格式。 4. 返回结果: 成功:返回业务数据,格式为JSON。 失败:返回错误码及错误信息。
三、签名算法 1. 将请求参数按照键值对的顺序进行排序,忽略签名参数。 2. 将排序后的参数拼接成一个字符串。 3. 使用企业密钥作为密钥,对字符串进行HMAC-SHA256加密。
4. 将加密后的字符串进行Base64编码,得到签名值。 四、示例 1. 请求示例: ```javascript var app_id = '123456'; var app_key = 'your_app_key'; var timestamp = '20220101123456'; var data = '{"name":"张三","age":20}'; var params = { 'app_id': app_id, 'app_key': app_key, 'timestamp': timestamp, 'sign': '' }; // 排序参数 var sortedParams = Object.keys(params).sort().map(function(key) { return params[key] + '='; }).join(''); // 签名 var sign = crypto.createHmac('sha256', app_key).update(sortedParams + 'data=' + JSON.stringify(data)).digest('base64'); params.sign = sign; // 请求URL var url = 'https://api.yourcompany.com/signature?' + Object.keys(params).map(function(key) { return key + '=' + params[key]; }).join('&'); // 发送请求 var request = require('request'); request.post(url, function(error, response, body) { console.log(body); }); ``` 2. 返回示例: ```json { "name": "张三", "age": 20 } ``` 五、注意事项 1. 请确保在使用API接口时,遵循相关法律法规。 2. 隐藏敏感信息,如应用密钥、用户数据等。
3. 请求时间戳需确保准确,避免因时间差异导致签名失败。 4. 在使用签名算法时,请确保企业密钥的安全性。 5. 如遇API调用异常,请查阅错误码及错误信息,并按照要求处理。
6. 如需修改应用配置或查询应用信息,请访问平台进行操作。 六、联系我们 如有任何疑问或需求,请联系企业签名技术支持: 邮箱:support@yourcompany.com 电话:+86-xxxxxxxxxx 感谢您选择我们的企业签名服务,祝您使用愉快!