
本教程详细阐述了将Python脚本中包含JSON字符串的POST请求转换为PHP实现的关键技巧。核心在于理解Python requests.post(data=…) 的行为,它将数据作为URL编码的表单提交,即使其中某个字段的值是JSON字符串。在PHP中,需确保仅将需要作为JSON字符串的特定字段进行 json_encode,而不是对整个请求体进行编码,以避免API返回“UNSUPPORTED.ACTION”错误,从而实现FedEx包裹追踪等复杂API调用的正确转换。
深入理解Python requests.post的数据处理机制
在进行api调用时,理解http请求体的构造方式至关重要。python的 requests 库提供了两种主要的方式来发送post请求的数据:data 参数和 json 参数。
- requests.post(url, data=…): 当使用 data 参数时,requests 库会将提供的数据(通常是一个字典或字节串)作为表单数据(application/x-www-form-urlencoded)进行编码并发送。这意味着,如果 data 参数的值是一个字典,requests 会将其键值对转换成 key1=value1&key2=value2 的形式。即使某个 value 本身是一个JSON字符串,它也会被作为普通字符串进行URL编码。
- requests.post(url, json=…): 当使用 json 参数时,requests 库会将提供的数据(通常是一个字典或列表)自动序列化为JSON字符串,并设置 Content-Type 头为 application/json。
在FedEx包裹追踪的Python示例中,我们可以看到如下代码片段:
data = requests.post('https://www.fedex.com/trackingCal/track', data={
'data': json.dumps({
'TrackPackagesRequest': {
# ... 省略内部结构 ...
}
}),
'action': 'trackpackages',
'locale': 'en_US',
'format': 'json',
'version': 99
}).json()
这里,requests.post 使用了 data 参数,并且其值是一个字典。注意,字典中的 data 键对应的值是通过 json.dumps() 序列化后的JSON字符串。这意味着整个请求体实际上是URL编码的表单数据,其中一个字段 data 的值恰好是JSON格式的字符串。服务器期望接收的是一个表单,而不是一个纯粹的JSON请求体。
PHP转换中的常见误区及原因分析
将上述Python逻辑转换为PHP时,常见的错误是直接将整个请求数据结构 json_encode 后作为请求体发送,并设置 Content-Type 为 application/json。
错误的PHP尝试可能如下所示:
立即学习“PHP免费学习笔记(深入)”;
<?php
// ... 省略初始化代码 ...
$headers = ['Content-Type' => 'application/json']; // 错误:不应是application/json
$data = ['data' => [ // 这是一个PHP数组
'TrackPackagesRequest' => [
// ... 省略内部结构 ...
]],
'action' => 'trackpackages',
'locale' => 'en_US',
'format' => 'json',
'version' => 99
];
$response = Requests::post($url, $headers, json_encode($data)); // 错误:对整个$data数组进行json_encode
print_r($response);
这段代码会返回 { “CALError”: { “code”:”UNSUPPORTED.ACTION”, “message”:” is not a supported action”, “rootCause”:null } } 错误。
原因分析:
- 错误的 Content-Type: 将 Content-Type 设置为 application/json 告诉服务器,整个请求体是一个JSON字符串。
- 错误的编码范围: json_encode($data) 将整个PHP数组 $data 转换成了一个JSON字符串。
这与Python脚本中实际发送的请求格式(URL编码的表单数据,其中一个字段的值是JSON字符串)不符。FedEx服务器期望的是一个包含 data、action、locale 等字段的表单,而不是一个直接以 TrackPackagesRequest 开头的JSON对象。
正确的PHP实现方式
要正确地将Python脚本中的逻辑转换为PHP,我们需要模拟Python requests.post(data=…) 的行为:发送URL编码的表单数据,并且只对 data 字段的值进行JSON编码。
以下是修正后的PHP代码示例:
<?php
// 假设您已经通过Composer安装了Requests库,并设置了自动加载
$dir = __DIR__;
include $dir .'/vendor/autoload.php'; // 引入Requests库
// 追踪号码示例
$tracking_number = '123456789';
// FedEx追踪API的URL
$url = 'https://www.fedex.com/trackingCal/track';
// HTTP请求头,这里不需要明确设置Content-Type为application/json
// Requests库在发送表单数据时会自动处理为 application/x-www-form-urlencoded
$headers = [];
// 构建请求数据数组
// 关键点:只有 'data' 字段的值需要被 json_encode
$data = [
"data" => json_encode([ // 将TrackPackagesRequest部分编码为JSON字符串
"TrackPackagesRequest" => [
"appType" => "wtrk",
"uniqueKey" => "",
"processingParameters" => [
"anonymousTransaction" => true,
"clientId" => "WTRK",
"returnDetailedErrors" => true,
"returnLocalizedDateTime" => false
],
"trackingInfoList" => [[
"trackNumberInfo" => [
"trackingNumber" => $tracking_number,
"trackingQualifier" => "",
"trackingCarrier" => ""
]
]]
]
]),
"action" => "trackpackages",
"locale" => "en_US",
"format" => "json",
"version" => 99
];
// 发送POST请求
// Requests::post() 方法如果接收一个数组作为第三个参数($data),
// 默认会将其作为 application/x-www-form-urlencoded 类型的表单数据发送
$response = Requests::post($url, $headers, $data);
// 打印API响应
print_r($response);
// 进一步处理响应(例如解析JSON)
if ($response->success) {
$responseData = json_decode($response->body, true);
// 提取所需信息
$fedex_status = $responseData['TrackPackagesResponse']['packageList'][0]['keyStatus'] ?? 'N/A';
$fedex_details = $responseData['TrackPackagesResponse']['packageList'][0]['statusWithDetails'] ?? 'N/A';
$delivery_date = $responseData['TrackPackagesResponse']['packageList'][0]['displayActDeliveryDt'] ?? 'N/A';
$delivery_time = $responseData['TrackPackagesResponse']['packageList'][0]['displayActDeliveryTm'] ?? 'N/A';
echo "FedEx Status: " . $fedex_status . "/n";
echo "Details: " . $fedex_details . "/n";
echo "Delivery Date: " . $delivery_date . "/n";
echo "Delivery Time: " . $delivery_time . "/n";
} else {
echo "Error: " . $response->status_code . " - " . $response->body . "/n";
}
?>
核心改进点:
- json_encode 的作用范围: json_encode 函数只应用于 $data 数组中键名为 “data” 的值。这样,TrackPackagesRequest 部分被正确地转换为一个JSON字符串。
- 请求体的构造: 外部的 $data 数组直接传递给 Requests::post 的第三个参数。Requests 库(或底层cURL)会负责将其编码为 application/x-www-form-urlencoded 格式的表单数据。
- Content-Type 头: 不再手动设置 Content-Type: application/json。让HTTP客户端库自动处理表单提交的 Content-Type,通常是 application/x-www-form-urlencoded。
关键要点与最佳实践
- 理解API文档: 在进行任何API集成时,仔细阅读API文档是第一步。了解API期望的请求方法(GET/POST)、请求体格式(application/x-www-form-urlencoded、application/json、multipart/form-data 等)以及所需的请求头。
-
区分表单数据和JSON数据:
- 表单数据 (Form Data):通常用于传统网页表单提交,数据以 key=value&key2=value2 的形式编码,Content-Type 通常为 application/x-www-form-urlencoded。
- JSON数据 (Raw JSON Body):整个请求体是一个JSON字符串,Content-Type 为 application/json。
- 本教程的案例是前者的一个变种:表单数据中包含一个值为JSON字符串的字段。
- 调试工具: 使用Postman、Insomnia或浏览器开发者工具的网络请求监控功能,可以捕获并分析Python脚本实际发送的HTTP请求,包括请求头和请求体,这对于复现请求格式至关重要。
- 错误处理: 在实际应用中,务必对API响应进行充分的错误检查和处理,包括HTTP状态码、API返回的错误信息等。
总结
将Python脚本中涉及复杂数据结构的POST请求转换为PHP时,关键在于精确复刻原始请求的HTTP协议细节。对于像FedEx追踪API这样期望URL编码表单数据,且其中某个字段值本身又是JSON字符串的场景,务必确保 json_encode 的作用范围仅限于该特定字段,而不是整个请求体。通过遵循这些原则,可以有效避免常见的API集成错误,确保跨语言代码转换的成功。
以上就是Python到PHP:FedEx追踪API的POST请求数据转换指南的详细内容,更多请关注php中文网其它相关文章!