云函数“from runtime import Args import hashlib import time import requests import json from…
- User
云函数“from runtime import Args import hashlib import time import requests import json from urllib.parse import urlencode
定义 Input 和 Output 类
class Input: def init(self, sid: str, app_key: str, app_secret: str, service_name: str): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.service_name = service_name
class Output: def init(self, result: dict): self.result = result
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items()))
# 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest()def call_api(service_name, sid, app_key, app_secret): """调用指定接口并返回结果""" # 准备公共请求参数 params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) }
# 生成签名 sign = generate_signature(params, app_secret) params["sign"] = sign # 设置请求URL和头信息 base_url = "https://sandbox.wangdian.cn/openapi2/" # 测试环境的基础URL url = f"{base_url}{service_name}" headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)}def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret service_name = args.input.service_name # 获取接口服务名
# 调用指定接口 result = call_api(service_name, sid, app_key, app_secret) # 返回接口调用结果作为输出 return Output(result)”已经测通,api接口如下“当前位置: API文档 > 基础类
logistics.php(查询物流)
¥标准
1.接口说明
1.1 接口描述:批量获取旺店通ERP内物流档案信息
1.2 适用版本:客户端 V2.4.5.0及以上版本
1.3 全量获取:该接口是全量获取数据或按照logistics_no获取,无法按照时间段增量获取数据。
2.调用场景2.1 暂无
3.请求参数说明3.1 请求地址
环境 HTTP地址 测试环境 https://sandbox.wangdian.cn/openapi2/logistics.php 正式环境 https://api.wangdian.cn/openapi2/logistics.php 3.2 公共请求参数
名称 字段 类型 长度 必须 描述 卖家账号 sid String 是 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 接口账号 appkey String 是 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 时间戳 timestamp int 是 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 签名 sign String 是 API输入参数签名结果,签名算法介绍单击这里 3.3 业务请求参数
名称 字段 类型 长度 必须 描述 物流编号 logistics_no varchar 20 否 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 物流公司名称 logistics_name varchar 40 否 物流公司名称(ERP中自定义的物流名称) 4.响应参数说明
4.1公共响应参数
名称 字段 类型 长度 必须 描述 错误码 code int 是 错误码,0成功 错误描述 message varchar 是 错误描述 物流档案列表节点 logistics_list data[ ] 是 物流档案列表节点 4.2业务响应参数
名称 字段 类型 长度 必须 描述 主键 logistics_id int 11 是 物流档案主键 物流编号 logistics_no varchar 20 是 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 物流名称 logistics_name varchar 40 是 物流公司名称(ERP中自定义的物流名称) 物流类型 logistics_type smallint 6 是 响应值为代表物流方式的数字,数字对应的物流方式名称单击这里 发件地址省份 province varchar 50 是 发件地址省份 发件地址市 city varchar 50 是 发件地址市 发件地址区 district varchar 50 是 发件地址区 联系人 contact varchar 64 是 联系人 联系电话 telno varchar 20 是 电话 手机 mobile varchar 20 是 手机 地址 address varchar 255 是 地址 佣金比例 commission_ratio decimal (5,4) 是 物流佣金比例 货运方式 send_type tinyint 6 是 货运方式:0.标准快递、1.生鲜速配、2.冷运速配 自定义属性1 prop1 varchar 255 是 自定义属性1 自定义属性2 prop2 varchar 255 是 自定义属性2 自定义属性3 prop3 varchar 255 是 自定义属性3 停用 is_disabled tinyint 1 是 是否禁用:0.否;1.是 分组 group_name varchar 40 是 物流分组 剩余单量 abled_num int 11 是 剩余单量 物流的优先级 priority int 11 是 物流的优先级,物流界面的顺序,从上至下依次递减 是否支持货到付款 is_support_cod tinyint 1 是 是否支持货到付款:0.否;1.是 业务模块 service_mask tinyint 1 是 1销售物流;2采购物流 单号类型 bill_type tinyint 1 是 0表示普通;1表示线下电子面单;2表示平台电子面单 是否启用在线发货 is_online tinyint 1 是 是否启用在线发货:0.否;1.是 是否”不使用接口大头笔” is_dtb_no_api tinyint 1 是 是否”不使用接口大头笔”:0.否;1.是 是否”不重复利用单号” un_repeat_logistics_no tinyint 1 是 是否”不重复利用单号”:0.否;1.是 手动获取单号 is_manual tinyint 1 是 是否手动获取单号:0.否;1.是 快递单的正则表达式 logistics_regex varchar 255 是 用来检查合法性 单号规则不校验 be_uncheck_regexp tinyint 1 是 校验物流单号正则表达式:0.校验;1.不校验 备注 remark varchar 128 是 备注 最后修改时间 modified datetime 255 是 最后修改时间 格式:yyyy-MM-dd HH:mm:ss 创建时间 created datetime 255 是 创建时间 格式:yyyy-MM-dd HH:mm:ss 邮编 zip varchar 255 是 邮编 5.请求示例
PHP JAVA C# python import WdtClient
t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/') params = {} params.update({"logistics_no": '123'})
response = t.execute("logistics.php", params) print(response) 6.响应示例
6.1 正常响应示例
JSON { "code": 0, "message": "OK", "logistics_list": [{ "logistics_id": "1", "logistics_type": "8", "is_support_cod": "1", "logistics_no": "SF001", "logistics_name": "顺丰快递", "logistics_regex": "", "contact": "小鹏", "telno": "13500001111", "mobile": "", "address": "花园路13", "service_mask": "3", "bill_type": "0", "is_online": "0", "is_manual": "0", "is_dtb_no_api": "0", "un_repeat_logistics_no": "0", "prop1": "", "prop2": "", "prop3": "", "is_disabled": "0", "commission_ratio": "0.0000", "send_type": "0", "be_uncheck_regexp": "1", "priority": "18", "remark": "测试物流", "modified": "2019-05-17 14:52:14", "created": "2018-11-23 14:56:13", "province": "北京", "city": "北京市", "district": "海淀区", "zip": "100089 " }] } 6.2 异常响应示例
JSON { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】}” ,帮我写个物流的查询云函数,api算法如下"Sign算法说明 注意事项:该算法为旺店通标准api签名计算规则,旺店通标准api不返回淘系及系统供销平台订单订单数据。如需全平台订单数据(含淘系及系统供销平台)请对接“奇门自定义接口”详细方法点击这里 举例:假设请求参数键值对如下 appkey : test2-xx page_no : 0 end_time : 2016-08-01 13:00:00 start_time : 2016-08-01 12:00:00 page_size : 40 sid : test2 timestamp : 1470042310 • 第一步 对数所有请求参数按照键名进行正序排序,排序结果如下,注意要保持键值对的对应关系且appsecret不参与运算。 appkey : test2-xx end_time : 2016-08-01 13:00:00 page_no : 0 page_size : 40 sid : test2 start_time : 2016-08-01 12:00:00 timestamp : 1470042310 • 第二步 循环对每个键值进行处理: 1.处理 appkey
1.1 appkey 采用utf8编码格式的字符长度并保留两位,不够的位数补0,计算结果为:06
1.2 将1.1计算的长度 06 和 appkey 用 - 作为分隔符进行拼接,拼接结果为 06-appkey
1.3 test2-xx 采用utf8编码格式的字符长度不足四位,保留四位,不够的位数补0,计算结果为:0008,如果超过4位,保留实际结果,如:10000
1.4 将1.3计算的长度 0008 和 test2-xx 用 - 作为分隔符进行拼接,拼接结果为 0008-test2-xx
1.5 将1.2 和 1.4 的拼接结果用 : 进行拼接 ,拼接结果为 06-appkey:0008-test2-xx
1.6 将1.5的结果最后拼接上分号 ; 拼接结果为 06-appkey:0008-test2-xx;
2.处理 end_time 同1处理
3.处理 page_no 同1处理
4.处理 page_size 同1处理
5.处理 sid 同1处理
6.处理 start_time 同1处理
7.处理 timestamp 注意前五步和1处理方法相同,因为 timestamp 是最后一个请求参数,所以不需要 1.6步骤
最后的处理结果为:
06-appkey:0008-test2-xx;08-end_time:0019-2016-08-01 13:00:00;07-page_no:0001-0;09-page_size:0002-40;03-sid:0005-test2;10-start_time:0019-2016-08-01 12:00:00;09-timestamp:0010-1470042310
注意:示例中的参数为查询类接口请求参数,创建类接口中的参数包含json串,比如:创建原始订单:trade_list = [] 这里是订单的json数据,json串当作正常的字符串进行处理 • 第三步 计算sign 1.获取appsecret 假如当前实例中的 appsecret 为 12345
2.将appsecret拼接在第二步的结果后面,注意没有任何拼接符,结果如下:06-appkey:0008-test2-xx;08-end_time:0019-2016-08-01 13:00:00;07-page_no:0001-0;09-page_size:0002-40;03-sid:0005-test2;10-start_time:0019-2016-08-01 12:00:00;09-timestamp:0010-147004231012345
3.将上述字符串进行md5加密后即可得到sign,要求MD5方法返回的是32位小写的MD5值,计算结果如下: ad4e6fe037ea6e3ba4768317be9d1309
4.将计算的sign作为一个请求参数放到参数列表中 sid : test2 appkey : test2-xx timestamp : 1470042310 start_time : 2016-08-01 12:00:00 end_time : 2016-08-01 13:00:00 page_no : 0 page_size : 40 sign : ad4e6fe037ea6e3ba4768317be9d1309”
- Assistant
根据您提供的API接口文档和需求,我为您编写了一个物流查询的云函数。这个函数会根据指定的参数生成签名,并通过 POST 请求调用物流查询的 API 接口。以下是实现的代码:
from runtime import Args import hashlib import time import requests import json class Input: def __init__(self, sid: str, app_key: str, app_secret: str, start_time: str, end_time: str, page_no: int, page_size: int): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.start_time = start_time self.end_time = end_time self.page_no = page_no self.page_size = page_size class Output: def __init__(self, result: dict): self.result = result def generate_signature(params, app_secret): """生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items())) formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest() def call_api(sid, app_key, app_secret, start_time, end_time, page_no, page_size): """调用物流查询接口并返回结果""" params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())), "start_time": start_time, "end_time": end_time, "page_no": page_no, "page_size": page_size } # 生成签名 sign = generate_signature(params, app_secret) # 添加签名到请求参数中 params["sign"] = sign # 设置请求URL和头信息 url = "https://sandbox.wangdian.cn/openapi2/logistics.php" headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)} def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret start_time = args.input.start_time end_time = args.input.end_time page_no = args.input.page_no page_size = args.input.page_size # 调用物流查询接口 result = call_api(sid, app_key, app_secret, start_time, end_time, page_no, page_size) # 返回接口调用结果作为输出 return Output(result)这个云函数的工作原理:
- 输入参数: 提供
sid,app_key,app_secret,start_time,end_time,page_no和page_size参数。 - 签名生成: 使用
generate_signature函数生成请求的签名。 - 调用接口: 通过
call_api函数调用指定的 API 接口,并返回结果。 - 输出结果: 返回 API 的响应结果作为云函数的输出。
注意事项:
- 确保传入的时间格式符合 API 的要求。
- 在调用正式环境 API 时,只需将 URL 更改为正式环境即可。
- 在实际使用时,您需要处理可能的异常和错误响应,以确保程序的健壮性。
- 输入参数: 提供
- User
这是物流查询api文档logistics.php(查询物流) ¥标准 1.接口说明
1.1 接口描述:批量获取旺店通ERP内物流档案信息 1.2 适用版本:客户端 V2.4.5.0及以上版本
1.3 全量获取:该接口是全量获取数据或按照logistics_no获取,无法按照时间段增量获取数据。 2.调用场景 2.1 暂无 3.请求参数说明 3.1 请求地址 环境 HTTP地址 测试环境 https://sandbox.wangdian.cn/openapi2/logistics.php 正式环境 https://api.wangdian.cn/openapi2/logistics.php 3.2 公共请求参数 名称 字段 类型 长度 必须 描述 卖家账号 sid String 是 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 接口账号 appkey String 是 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 时间戳 timestamp int 是 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 签名 sign String 是 API输入参数签名结果,签名算法介绍单击这里 3.3 业务请求参数 名称 字段 类型 长度 必须 描述 物流编号 logistics_no varchar 20 否 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 物流公司名称 logistics_name varchar 40 否 物流公司名称(ERP中自定义的物流名称) 4.响应参数说明 4.1公共响应参数 名称 字段 类型 长度 必须 描述 错误码 code int 是 错误码,0成功 错误描述 message varchar 是 错误描述 物流档案列表节点 logistics_list data[ ] 是 物流档案列表节点 4.2业务响应参数 名称 字段 类型 长度 必须 描述 主键 logistics_id int 11 是 物流档案主键 物流编号 logistics_no varchar 20 是 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 物流名称 logistics_name varchar 40 是 物流公司名称(ERP中自定义的物流名称) 物流类型 logistics_type smallint 6 是 响应值为代表物流方式的数字,数字对应的物流方式名称单击这里 发件地址省份 province varchar 50 是 发件地址省份 发件地址市 city varchar 50 是 发件地址市 发件地址区 district varchar 50 是 发件地址区 联系人 contact varchar 64 是 联系人 联系电话 telno varchar 20 是 电话 手机 mobile varchar 20 是 手机 地址 address varchar 255 是 地址 佣金比例 commission_ratio decimal (5,4) 是 物流佣金比例 货运方式 send_type tinyint 6 是 货运方式:0.标准快递、1.生鲜速配、2.冷运速配 自定义属性1 prop1 varchar 255 是 自定义属性1 自定义属性2 prop2 varchar 255 是 自定义属性2 自定义属性3 prop3 varchar 255 是 自定义属性3 停用 is_disabled tinyint 1 是 是否禁用:0.否;1.是 分组 group_name varchar 40 是 物流分组 剩余单量 abled_num int 11 是 剩余单量 物流的优先级 priority int 11 是 物流的优先级,物流界面的顺序,从上至下依次递减 是否支持货到付款 is_support_cod tinyint 1 是 是否支持货到付款:0.否;1.是 业务模块 service_mask tinyint 1 是 1销售物流;2采购物流 单号类型 bill_type tinyint 1 是 0表示普通;1表示线下电子面单;2表示平台电子面单 是否启用在线发货 is_online tinyint 1 是 是否启用在线发货:0.否;1.是 是否”不使用接口大头笔” is_dtb_no_api tinyint 1 是 是否”不使用接口大头笔”:0.否;1.是 是否”不重复利用单号” un_repeat_logistics_no tinyint 1 是 是否”不重复利用单号”:0.否;1.是 手动获取单号 is_manual tinyint 1 是 是否手动获取单号:0.否;1.是 快递单的正则表达式 logistics_regex varchar 255 是 用来检查合法性 单号规则不校验 be_uncheck_regexp tinyint 1 是 校验物流单号正则表达式:0.校验;1.不校验 备注 remark varchar 128 是 备注 最后修改时间 modified datetime 255 是 最后修改时间 格式:yyyy-MM-dd HH:mm:ss 创建时间 created datetime 255 是 创建时间 格式:yyyy-MM-dd HH:mm:ss 邮编 zip varchar 255 是 邮编 5.请求示例 PHP JAVA C# python 1 2 3 4 5 6 7 8 9 10 11 12 6.响应示例 6.1 正常响应示例 JSON 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 { "code": 0, "message": "OK", "logistics_list": [{ "logistics_id": "1", "logistics_type": "8", "is_support_cod": "1", "logistics_no": "SF001", "logistics_name": "顺丰快递", "logistics_regex": "", "contact": "小鹏", "telno": "13500001111", "mobile": "", "address": "花园路13", "service_mask": "3", "bill_type": "0", "is_online": "0", "is_manual": "0", "is_dtb_no_api": "0", "un_repeat_logistics_no": "0", "prop1": "", "prop2": "", "prop3": "", "is_disabled": "0", "commission_ratio": "0.0000", "send_type": "0", "be_uncheck_regexp": "1", "priority": "18", "remark": "测试物流", "modified": "2019-05-17 14:52:14", "created": "2018-11-23 14:56:13", "province": "北京", "city": "北京市", "district": "海淀区", "zip": "100089 " }] } 6.2 异常响应示例 JSON 1 2 3 4 { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 " }“”,请参见这个函数编写物流查询的函数“from runtime import Args import hashlib import time import requests import json from urllib.parse import urlencode定义 Input 和 Output 类 class Input: def init(self, sid: str, app_key: str, app_secret: str, service_name: str): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.service_name = service_name
class Output: def init(self, result: dict): self.result = result
def generate_signature(params, app_secret): """按照文档要求生成签名"""
1. 参数排序
sorted_params = dict(sorted(params.items()))
2. 处理每个键值对
formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}"
# 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair)3. 用分号连接所有处理后的键值对
sign_str = ';'.join(formatted_pairs)
4. 拼接appsecret并进行MD5加密
final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest() Use code with caution. def call_api(service_name, sid, app_key, app_secret): """调用指定接口并返回结果"""
准备公共请求参数
params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) }
生成签名
sign = generate_signature(params, app_secret) params["sign"] = sign
设置请求URL和头信息
base_url = "https://sandbox.wangdian.cn/openapi2/" # 测试环境的基础URL url = f"{base_url}{service_name}" headers = {'Content-Type': 'application/x-www-form-urlencoded'}
try: # 发送POST请求 response = requests.post(url, data=params, headers=headers)
# 返回响应结果 return response.json()except requests.exceptions.RequestException as e: return {"error": str(e)} Use code with caution. def handler(args: Args[Input]) -> Output: """处理插件的入口函数"""
从输入参数中获取所需的值
sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret service_name = args.input.service_name # 获取接口服务名
调用指定接口
result = call_api(service_name, sid, app_key, app_secret)
返回接口调用结果作为输出
return Output(result)
- Assistant
根据您提供的物流查询API文档和示例,我将为您编写一个完整的云函数,以根据指定的输入参数查询物流信息。该函数将生成签名并调用API,返回查询结果。以下是实现的代码:
from runtime import Args import hashlib import time import requests import json # 定义 Input 和 Output 类 class Input: def __init__(self, sid: str, app_key: str, app_secret: str, logistics_no: str = None, logistics_name: str = None): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.logistics_no = logistics_no self.logistics_name = logistics_name class Output: def __init__(self, result: dict): self.result = result def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items())) # 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest() def call_api(sid, app_key, app_secret, logistics_no=None, logistics_name=None): """调用物流查询接口并返回结果""" # 准备公共请求参数 params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) } # 添加业务请求参数 if logistics_no: params["logistics_no"] = logistics_no if logistics_name: params["logistics_name"] = logistics_name # 生成签名 sign = generate_signature(params, app_secret) params["sign"] = sign # 设置请求URL和头信息 url = "https://sandbox.wangdian.cn/openapi2/logistics.php" # 测试环境的URL headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)} def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret logistics_no = args.input.logistics_no # 可选参数 logistics_name = args.input.logistics_name # 可选参数 # 调用物流查询接口 result = call_api(sid, app_key, app_secret, logistics_no, logistics_name) # 返回接口调用结果作为输出 return Output(result)代码说明:
- 输入类
Input: 包含必要的认证信息和可选的请求参数(如logistics_no和logistics_name)。 - 输出类
Output: 用于返回 API 响应的结果。 generate_signature方法: 根据提供的参数生成 API 调用需要的签名。call_api方法: 准备 API 请求的参数,调用物流查询接口并返回结果。handler方法: 作为云函数的入口,根据输入调用 API 并返回结果。
使用示例:
要使用这个函数,您需要提供
sid、app_key、app_secret,以及可选的logistics_no和logistics_name参数。这个函数可以被嵌入到您的云服务中,来查询物流信息。确保根据实际情况调整测试和正式环境的 API URL。 - 输入类
- User
函数“from runtime import Args import hashlib import time import requests import json
定义 Input 和 Output 类
class Input: def init(self, sid: str, app_key: str, app_secret: str, logistics_no: str = None, logistics_name: str = None): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.logistics_no = logistics_no self.logistics_name = logistics_name
class Output: def init(self, result: dict): self.result = result
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items()))
# 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest()def call_api(sid, app_key, app_secret, logistics_no=None, logistics_name=None): """调用物流查询接口并返回结果""" # 准备公共请求参数 params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) }
# 添加业务请求参数 if logistics_no: params["logistics_no"] = logistics_no if logistics_name: params["logistics_name"] = logistics_name # 生成签名 sign = generate_signature(params, app_secret) params["sign"] = sign # 设置请求URL和头信息 url = "https://sandbox.wangdian.cn/openapi2/logistics.php" # 测试环境的URL headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)}def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret logistics_no = args.input.logistics_no # 可选参数 logistics_name = args.input.logistics_name # 可选参数
# 调用物流查询接口 result = call_api(sid, app_key, app_secret, logistics_no, logistics_name) # 返回接口调用结果作为输出 return Output(result)”,输入的测试json“{"sid": "apidevnew2", "app_key": "ftxfs2-test", "app_secret": "15c237c9c", "logistics_no": "SF001", "logistics_name": "顺丰快递", "service_name": "logistics.php" }”就是提示错误“{"result":{"code":2100,"message":"sign计算错误,请检查计算方式是否正确或有无特殊字符表情符号"}}”
- Assistant
根据您提供的错误信息
{"code":2100,"message":"sign计算错误,请检查计算方式是否正确或有无特殊字符表情符号"},这表明生成的签名有问题。为了排查该问题,我们可以关注以下几个方面:- 签名的生成逻辑:确保所有的参数都正确地按照文档中的要求进行排序和处理。
- 参数的字符编码:确保参数在拼接时的字符编码与要求一致(通常是UTF-8)。
- 特殊字符处理:检查输入的参数是否包含特殊字符或表情符号,这可能会影响签名的计算。
更新签名生成逻辑
我们可以进一步检查签名生成的代码,确保每个步骤都符合API文档的描述。下面是针对签名生成的一些改进:
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items())) # 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key)).zfill(2) # 使用实际字符长度 key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str)).zfill(4) # 使用实际字符长度 value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" signature = hashlib.md5(final_str.encode('utf-8')).hexdigest() return signature样本输入参数的处理
确保你的输入参数都按照要求设置,并且注意以下几点:
- 确保输入的参数没有多余的空格或特殊字符。例如,
logistics_no和logistics_name应该是有效的字符串。 - 可能缺少的参数:如果 API 文档要求某些参数而您没有提供,则签名可能会计算错误。
- 报告的参数:检查 API 文档是否有未被处理的参数,如果存在可能会影响最终计算的参数需要处理。
代码更新后的完整实现示例
组合所有内容,最终更新后的完整函数可以是:
from runtime import Args import hashlib import time import requests import json class Input: def __init__(self, sid: str, app_key: str, app_secret: str, logistics_no: str = None, logistics_name: str = None): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.logistics_no = logistics_no self.logistics_name = logistics_name class Output: def __init__(self, result: dict): self.result = result def generate_signature(params, app_secret): """按照文档要求生成签名""" sorted_params = dict(sorted(params.items())) formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: key_length = str(len(key)).zfill(2) key_part = f"{key_length}-{key}" value_str = str(value) value_length = str(len(value_str)).zfill(4) value_part = f"{value_length}-{value_str}" pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) sign_str = ';'.join(formatted_pairs) final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest() def call_api(sid, app_key, app_secret, logistics_no=None, logistics_name=None): params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) } if logistics_no: params["logistics_no"] = logistics_no if logistics_name: params["logistics_name"] = logistics_name sign = generate_signature(params, app_secret) params["sign"] = sign url = "https://sandbox.wangdian.cn/openapi2/logistics.php" headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: response = requests.post(url, data=params, headers=headers) return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)} def handler(args: Args[Input]) -> Output: sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret logistics_no = args.input.logistics_no logistics_name = args.input.logistics_name result = call_api(sid, app_key, app_secret, logistics_no, logistics_name) return Output(result)测试输入 JSON
使用以下 JSON 测试输入函数,确保在代码中正确解析这些参数:
{ "sid": "apidevnew2", "app_key": "ftxfs2-test", "app_secret": "15c237c9c", "logistics_no": "SF001", "logistics_name": "顺丰快递" }如果仍然有问题,您可能需要仔细检查您在 API 调用时使用的参数,确保它们的准确性和完整性。
- User
”from runtime import Args import hashlib import time import requests import json from urllib.parse import urlencode
定义 Input 和 Output 类
class Input: def init(self, sid: str, app_key: str, app_secret: str, service_name: str, shop_no=None, platform_id=None, platform_ids=None, page_size=30, page_no=0, is_disabled="0"): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.service_name = service_name self.shop_no = shop_no self.platform_id = platform_id self.platform_ids = platform_ids self.page_size = page_size self.page_no = page_no self.is_disabled = is_disabled
class Output: def init(self, result: dict): self.result = result
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items()))
# 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value not in ['', None]: # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest()def call_api(service_name, sid, app_key, app_secret, shop_no=None, platform_id=None, platform_ids=None, page_size=30, page_no=0, is_disabled="0"): """调用指定接口并返回结果""" # 准备公共请求参数 params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) }
# 添加业务请求参数 if shop_no: params["shop_no"] = shop_no if platform_id: params["platform_id"] = platform_id if platform_ids: params["platform_ids"] = platform_ids params["page_size"] = page_size params["page_no"] = page_no params["is_disabled"] = is_disabled # 生成签名 sign = generate_signature(params, app_secret) params["sign"] = sign # 设置请求URL和头信息 base_url = "https://sandbox.wangdian.cn/openapi2/" # 测试环境的基础URL url = f"{base_url}{service_name}" headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)}def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret service_name = args.input.service_name # 获取接口服务名
# 获取业务请求参数 shop_no = args.input.shop_no platform_id = args.input.platform_id platform_ids = args.input.platform_ids page_size = args.input.page_size page_no = args.input.page_no is_disabled = args.input.is_disabled # 调用指定接口 result = call_api(service_name, sid, app_key, app_secret, shop_no, platform_id, platform_ids, page_size, page_no, is_disabled) # 返回接口调用结果作为输出 return Output(result)“和函数”from runtime import Args import hashlib import time import requests import json
定义 Input 和 Output 类
class Input: def init(self, sid: str, app_key: str, app_secret: str, logistics_no: str = None, logistics_name: str = None): self.sid = sid self.app_key = app_key self.app_secret = app_secret self.logistics_no = logistics_no self.logistics_name = logistics_name
class Output: def init(self, result: dict): self.result = result
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = dict(sorted(params.items()))
# 2. 处理每个键值对 formatted_pairs = [] for key, value in sorted_params.items(): if value is not None: # 处理key key_bytes = key.encode('utf-8') key_length = str(len(key_bytes)).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_bytes = value_str.encode('utf-8') value_length = str(len(value_bytes)).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" # 计算MD5签名 signature = hashlib.md5(final_str.encode('utf-8')).hexdigest() return signaturedef call_api(sid, app_key, app_secret, logistics_no=None, logistics_name=None): """调用物流查询接口并返回结果""" # 准备公共请求参数 params = { "sid": sid, "appkey": app_key, "timestamp": str(int(time.time())) }
# 添加业务请求参数 if logistics_no is not None: params["logistics_no"] = logistics_no if logistics_name is not None: params["logistics_name"] = logistics_name # 生成签名 sign = generate_signature(params, app_secret) params["sign"] = sign # 设置请求URL和头信息 url = "https://sandbox.wangdian.cn/openapi2/logistics.php" # 测试环境的URL headers = {'Content-Type': 'application/x-www-form-urlencoded'} try: # 发送POST请求 response = requests.post(url, data=params, headers=headers) # 返回响应结果 return response.json() except requests.exceptions.RequestException as e: return {"error": str(e)}def handler(args: Args[Input]) -> Output: """处理插件的入口函数""" # 从输入参数中获取所需的值 sid = args.input.sid app_key = args.input.app_key app_secret = args.input.app_secret logistics_no = args.input.logistics_no logistics_name = args.input.logistics_name
# 调用物流查询接口 result = call_api(sid, app_key, app_secret, logistics_no, logistics_name) # 返回接口调用结果作为输出 return Output(result)“比较一下这两个函数的不同,后一个就提示错误”{result:{ code:2100, message:"sign计算错误,请检查计算方式是否正确或有无特殊字符表情符号" } }“,输入json是”{ "sid": "apidevnew2", "app_key": "ftxfs2-test", "app_secret": "15c237c9c", "logistics_no": "SF001", "logistics_name": "顺丰快递" }“,如果输入”{ "sid": "apidevnew2", "app_key": "ftxfs2-test", "app_secret": "15c237c9c"
}“就没问题。
- Assistant
在比较这两个代码段时,我们发现它们的处理方式和参数结构有显著的不同。我们将逐步分析每个部分,找出可能导致签名计算错误的原因。
1. 输入参数结构
两个函数的输入参数结构不同:
- 第一个函数:输入类
Input包含了多个字段,如shop_no、platform_id、platform_ids等,以及分页参数page_size和page_no等。这设计适用于处理更复杂的请求。 - 第二个函数:输入类
Input只是包含了logistics_no和logistics_name等业务请求参数,结构较简单。
2. 签名计算的代码差异
签名生成的具体实现略有不同。我们将其分为几个重要的步骤来比较和分析。
关键差异分析
-
字符串长度处理
- 第一个函数中,key和value的长度计算使用了
len(key.encode('utf-8'))和len(value_str.encode('utf-8')),这在某些情况下可能会影响签名的准确性。 - 第二个函数中,key和value的长度使用的是
len(key)和len(value_str),这个方法简单明了且适合大多数情况,但缺乏对特殊字符的处理。
- 第一个函数中,key和value的长度计算使用了
-
值的处理:
- 第一个函数中,
if value not in ['', None]:用于判断值是否有效,可以避免空字符串参数导致的错误。 - 第二个函数中,
if value is not None:只检查值是否为None,没有处理空字符串,可能导致空字符串不被正确处理。
- 第一个函数中,
-
参数拼接顺序:
- 第一个函数直接添加了分页和默认参数。这种情况下,即使你没有传递
logistics_no或logistics_name,这些参数默认填写可能导致签名的变化。
- 第一个函数直接添加了分页和默认参数。这种情况下,即使你没有传递
3. 代码建议与调整
要解决第二个函数签名计算问题,您可以考虑以下调整:
- 确保所有的输入参数在生成签名之前得到了适当的处理。例如,检查是否有空字符串,否则忽略它们。
- 在生成签名时,确保所有的输入参数都得到一致的处理(即 Unicode 编码和字符串长度计算的方式一致)。
- 考虑在参数中只包含非空且需要的参数。
修订后的签名生成代码
以下是您可以尝试的修订:
def generate_signature(params, app_secret): """按照文档要求生成签名""" # 1. 参数排序 sorted_params = {k: v for k, v in sorted(params.items()) if v not in ['', None]} # 过滤掉空值 formatted_pairs = [] # 2. 处理每个键值对 for key, value in sorted_params.items(): # 处理key key_length = str(len(key.encode('utf-8'))).zfill(2) key_part = f"{key_length}-{key}" # 处理value value_str = str(value) value_length = str(len(value_str.encode('utf-8'))).zfill(4) value_part = f"{value_length}-{value_str}" # 拼接键值对 pair = f"{key_part}:{value_part}" formatted_pairs.append(pair) # 3. 用分号连接所有处理后的键值对 sign_str = ';'.join(formatted_pairs) # 4. 拼接appsecret并进行MD5加密 final_str = f"{sign_str}{app_secret}" return hashlib.md5(final_str.encode('utf-8')).hexdigest()最后测试
使用您提供的输入JSON:
{ "sid": "apidevnew2", "app_key": "ftxfs2-test", "app_secret": "15c237c9c", "logistics_no": "SF001", "logistics_name": "顺丰快递" }验证修订后的代码是否解决了签名计算错误的问题。确保
logistics_no和logistics_name不为空,并且确保它们被正确地编码并纳入到签名计算中。 - 第一个函数:输入类