API接口文档的作用和意义:
API分为很多种,最基础也是产品最需要的诸如短信API,地图API,语音API等,如果我们的产品涉及到此方面的功能,那就必须了解这方面的API以便于在需求设计阶段考虑更全面。
这里说白一点就是防止被程序员欺骗。你走过去,发现程序员正在勤勤恳恳,对不起,人家在做外包,就是欺负你代码看不懂,气不气?但是如果你知道接口的难度和工作量,规定他在多久之内给你,就不会出现拖延项目的情况,也更有利于项目流程的更进。
一些关键接口、数据量大需要进行大数据压测的接口,必须经过测试,测出它的最大访问量,并对其进行优化或者设置限制,防止系统崩溃。
PM懂一点技术,就不会闹出明明不能做,却还非要程序员做出来的笑话了。从这个角度看,也更有利于PM和程序员之间的团队沟通与和谐,避免矛盾,不至于弄翻友谊的小船。了解API可以使PM对技术理解更深刻,更好地衡量开发工作量和制定功能内容。
公共参数
请求地址:注册调用key接入
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
key | String | 是 | 调用key(必须以GET方式拼接在URL中) |
secret | String | 是 | 调用密钥 |
api_name | String | 是 | API接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等] |
cache | String | 否 | [yes,no]默认yes,将调用缓存的数据,速度比较快 |
result_type | String | 否 | [json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读 |
lang | String | 否 | [cn,en,ru]翻译语言,默认cn简体中文 |
version | String | 否 | API版本 |
请求参数
请求参数:num_iid=725962595144
参数说明:num_iid:商品ID
响应参数
Version: Date:
名称 | 类型 | 必须 | 示例值 | 描述 |
---|---|---|---|---|
items | items[] | 0 | 获得商品跨境属性 | |
item_weight | Float | 0 | 0.1 | 跨境包裹重量 |
unit_weight | Float | 0 | 0.1 | 单位重量 |
volume_length | Float | 0 | 8 | 产品体积:长 |
volume_width | Float | 0 | 6 | 产品体积:宽 |
volume_height | Float | 0 | 2.8 | 产品体积:高 |
PHP请求示例
&secret=<您自己的apiSecret>&num_iid=725962595144";
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST,FALSE);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER,FALSE);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_ENCODING, "gzip");
var_dump(curl_exec($curl));
?>
响应示例
{
"item": {
"item_weight": 0.1,
"unit_weight": 0.1,
"volume_length": 8,
"volume_width": 6,
"volume_height": 2.8,
"_ddf": "ti"
},
"error": "",
"reason": "",
"error_code": "0000",
"cache": 0,
"api_info": "today:58 max:10100 all[106=58+24+24];expires:2030-12-31",
"execution_time": "1.612",
"server_time": "Beijing/2023-07-25 10:26:28",
"client_ip": "115.153.49.128",
"call_args": [],
"api_type": "1688",
"translate_language": "zh-CN",
"translate_engine": "baidu",
"server_memory": "3.99MB",
"request_id": "1.64bf32d324b3b",
"last_id": "1898688318"
}