获取面单(HTML)
接口说明
按 WMG 单号获取包裹面单,返回面单的完整 HTML 文档字符串。
请求信息
- 方法:GET
- 路径:
/openapi/order-shipping-label/get-shipping-label-html - 认证方式:标准 OpenAPI token(基于 MD5)
请求头
| 字段 | 说明 |
|---|---|
| Content-Type | application/json |
| x-auth-name | $API_NAME |
| x-auth-seed | $SEED(13 位毫秒级 UNIX 时间戳) |
| x-auth-token | $TOKEN(MD5 哈希) |
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tracking_num | string | 是 | WMG 包裹单号 |
Token 生成说明
token 只由凭证和 seed 计算得出 —— 请求参数不参与。
seed = "1746700000000" (13 位毫秒时间戳)
token = md5( strtolower(api_name) + api_key + seed )认证
本接口使用标准 OpenAPI 认证(MD5 token)。
完整的认证说明与多语言示例见认证与签名。
响应信息
响应为 JSON 格式。
响应结构
| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 结果码。0 = 成功,1 = 失败 |
| message | string | 结果描述 |
| data | object | 响应数据 |
成功响应
- HTTP 状态码:200
json
{
"code": 0,
"message": "success",
"data": {
"html": "<!doctype html><html lang='en'><head><meta charset='UTF-8'><meta name='viewport' content='width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0'><meta http-equiv='X-UA-Compatible' content='ie=edge'><title>Document</title></head><body></body></html>"
}
}| 字段 | 类型 | 说明 |
|---|---|---|
| data.html | string | 面单的完整 HTML 文档字符串 |
失败响应
- HTTP 状态码:200(业务错误)或 4xx/5xx(系统错误)
json
{
"code": 1,
"message": "Order Not Found!",
"data": []
}常见错误:
- 认证失败 → code
1;具体 message 取决于失败原因(如x-auth-token: INVALID、x-auth-seed: TIMEOUT)—— 见认证与签名 - 单号不存在 → code
1,message 为Order Not Found!
结果码
| Code | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 失败 |
调用示例
Bash
bash
API_NAME="your_api_name"
API_KEY="your_api_key"
SEED=$(date +%s%3N)
TOKEN=$(printf '%s' "$(echo -n "$API_NAME" | tr '[:upper:]' '[:lower:]')${API_KEY}${SEED}" | md5sum | cut -d' ' -f1)
# Save HTML label to file
curl -G "https://api.test.wmgdelivery.com/v1/openapi/order-shipping-label/get-shipping-label-html" \
--data-urlencode "tracking_num=WMG1234567" \
-H "x-auth-name: $API_NAME" \
-H "x-auth-seed: $SEED" \
-H "x-auth-token: $TOKEN" \
| python3 -c "import sys,json; d=json.load(sys.stdin); open('label.html','w').write(d['data']['html'])"Windows PowerShell
powershell
$API_NAME = "your_api_name"
$API_KEY = "your_api_key"
$SEED = [string]([DateTimeOffset]::UtcNow.ToUnixTimeMilliseconds())
$raw = [System.Text.Encoding]::UTF8.GetBytes($API_NAME.ToLower() + $API_KEY + $SEED)
$md5 = [System.Security.Cryptography.MD5]::Create().ComputeHash($raw)
$TOKEN = -join ($md5 | ForEach-Object { $_.ToString("x2") })
$headers = @{
"x-auth-name" = $API_NAME
"x-auth-seed" = $SEED
"x-auth-token" = $TOKEN
}
$response = Invoke-RestMethod `
-Uri "https://api.test.wmgdelivery.com/v1/openapi/order-shipping-label/get-shipping-label-html?tracking_num=WMG1234567" `
-Method Get -Headers $headers
# Save HTML to file
$response.data.html | Out-File -FilePath "label.html" -Encoding utf8
Write-Host "Label saved to label.html"Python
python
import hashlib, time
import requests
API_NAME = 'your_api_name'
API_KEY = 'your_api_key'
SEED = str(int(time.time() * 1000))
TOKEN = hashlib.md5((API_NAME.lower() + API_KEY + SEED).encode()).hexdigest()
headers = {
'x-auth-name': API_NAME,
'x-auth-seed': SEED,
'x-auth-token': TOKEN,
}
resp = requests.get(
'https://api.test.wmgdelivery.com/v1/openapi/order-shipping-label/get-shipping-label-html',
params={'tracking_num': 'WMG1234567'},
headers=headers,
)
data = resp.json()
if data['code'] == 0:
with open('label.html', 'w', encoding='utf-8') as f:
f.write(data['data']['html'])
print('Label saved to label.html')
else:
print('Error:', data['message'])Node.js / TypeScript
typescript
import crypto from 'node:crypto';
import fs from 'node:fs';
const API_NAME = 'your_api_name';
const API_KEY = 'your_api_key';
const SEED = String(Date.now());
const TOKEN = crypto.createHash('md5').update(API_NAME.toLowerCase() + API_KEY + SEED).digest('hex');
const url = new URL('https://api.test.wmgdelivery.com/v1/openapi/order-shipping-label/get-shipping-label-html');
url.searchParams.set('tracking_num', 'WMG1234567');
const resp = await fetch(url.toString(), {
headers: {
'x-auth-name': API_NAME,
'x-auth-seed': SEED,
'x-auth-token': TOKEN,
},
});
const data = await resp.json() as { code: number; data: { html: string } };
if (data.code === 0) {
fs.writeFileSync('label.html', data.data.html, 'utf-8');
console.log('Label saved to label.html');
}PHP
php
<?php
$API_NAME = 'your_api_name';
$API_KEY = 'your_api_key';
$SEED = (string)(time() * 1000);
$TOKEN = md5(strtolower($API_NAME) . $API_KEY . $SEED);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.test.wmgdelivery.com/v1/openapi/order-shipping-label/get-shipping-label-html?' . http_build_query(['tracking_num' => 'WMG1234567']));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-auth-name: ' . $API_NAME,
'x-auth-seed: ' . $SEED,
'x-auth-token: ' . $TOKEN,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
if ($data['code'] === 0) {
file_put_contents('label.html', $data['data']['html']);
echo "Label saved to label.html\n";
} else {
echo 'Error: ' . $data['message'] . "\n";
}
?>注意事项
- 浏览器内预览时,把
data.html注入<iframe>的srcdoc属性,或写入新开的浏览器窗口。 - 认证 token 不包含请求参数,只用凭证和 seed 计算。
x-auth-seed必须是 13 位毫秒级 UNIX 时间戳,且与服务器时间相差不超过 ±10 分钟。- 所有参数区分大小写。
错误码
| code | message | 说明 |
|---|---|---|
1 | 认证错误消息 | 认证失败;具体 message 取决于失败原因 —— 完整清单见认证与签名 |
1 | Order Not Found! | 当前客户下不存在该 tracking_num 对应的订单 |
1 | 承运商接口错误 | 面单生成链路(Singpost / Spring / PDF 生成)返回错误时透传,message 文本来自承运商服务 |