1,请求协议说明:
填充参数>生成签名>拼装HTTP请求>发起HTTP请求>得到HTTP响应>解析json
2,接口协议:
规则 | 说明 | 传输协议 | http | 参数格式 | application/x-www-form-urlencoded | 字符编码 | utf-8 | 请求方式 | POST |
3,返回值规则
规则 | 说明 | 数据格式 | application/json | 字符编码 | utf-8 | 数据结构 | {“code”: 状态码,“message”: 错误信息, “data”: 数据} |
4,公共参数
键 | 值 | 类型 | 说明 | version | v1 | string | 版本很重要,在后期拥有客户端时,更是非常重要,没有版本,对客户端来说灾难性的 | sign | 8318c44177c89ecf127e65be4720c8fe | string | 详见签名生成 | timestamp | 1629272078451 | string | 复杂签名用的也是记录 | data | | string | json串或者纯字符串 |
5,接口签名
1:为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名,开放平台服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。
2:将所有公共参数按照字典顺序进行排序,排除值为空以及sign字段
3:将参数以参数1值1参数2值2...的正序拼接,例如a=&c=3&b=1,变为b1c3,参数使用utf-8编码
4: 按照AppSecret + 排序后的参数的顺序进行连接,得到加密前的字符串
对加密前的字符串进行MD5加密(32位大写加密),得到的MD5加密值最后转为"大写"赋给sign作为请求的参数
参考方法:
varsion=v1
timestamp=1629272078451
appSecret:vvvvfff
data={"cityId":"1101"}
那么拼接成的加密串为 vvvvfffdata{"cityId":"1101"}timestamp1111111versionv1
然后用MD5.hexdigest().upper()得到签名
6,php代码案例
<?php
private function sign($config, $secret)
{
$str = "";
ksort($config);
foreach ($config as $k => $v) {
$str .= $k . $v;
}
return strtoupper(md5($secret . $str));
}
7, python代码案例
def sign(config, secret=""):
"""
:param config: dict
:param secret: str
:return:
"""
data_ksort = {k: v for k, v in sorted(config.items(), key=lambda k: k[0])}
sign_string = ""
for (key, value) in data_ksort.items():
sign_string += "{}{}".format(key, value)
sign_string = secret + sign_string
MD5 = hashlib.md5()
MD5.update(sign_string.encode(encoding='utf-8'))
return MD5.hexdigest().upper()
|