非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。
参数名称 | 类型 | 示例值 | 必须 | 描述 |
---|---|---|---|---|
showapi_appid | String | 100 | 是 | 易源应用id |
showapi_sign | String | 698d51a19d8a121ce581499d7b701668 | 是 | 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 |
showapi_timestamp | String | 20141114142239 | 否 | 客户端时间。
格式yyyyMMddHHmmss,如20141114142239 为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。 |
showapi_sign_method | String | md5 | 否 | 签名生成方式,其值可选为"md5"或"hmac"。如果不传入则默认"md5"。 |
showapi_res_gzip | String | 1或0 | 否 | 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 |
... |
参数名称 | 类型 | 默认值 | 示例值 | 必须 | 描述 |
---|---|---|---|---|---|
api_code | String | 64 |
是 | 接口编码 |
|
point_code | String | 19 |
是 | 接入点编码 |
以JSON格式返回结果。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
showapi_res_body | String | {"city":"昆明","prov":"云南"} | 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 |
showapi_res_code | int | 0 |
易源返回标志,0为成功,其他为失败。
0成功 -1,系统调用错误 -2,可调用次数或金额为0 -3,读取超时 -4,服务端返回数据解析错误 -5,后端服务器DNS解析错误 -6,服务不存在或未上线 -1000,系统维护 -1002,showapi_appid字段必传 -1003,showapi_sign字段必传 -1004,签名sign验证有误 -1005,showapi_timestamp无效 -1006,app无权限调用接口 -1007,没有订购套餐 -1008,服务商关闭对您的调用权限 -1009,调用频率受限 -1010,找不到您的应用 -1011,子授权app_child_id无效 -1012,子授权已过期或失效 -1013,子授权ip受限 |
showapi_res_error | String | 用户输入有误! | 错误信息的展示 |
... |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
apiName | String | 全国快递查询 |
接口名称 |
dayGift | String | 0 |
每日赠送多少次 |
money | String | 0 |
剩余金额,单位元。当接入点为充值类(话费、油卡)时,此字段才有意义。 |
monthDayNum | String | 2000 |
包月套餐的每日调用剩余量,此字段每日凌晨初始化。 |
monthStartDay | String | 20150717 |
包月套餐的开始时间 |
monthEndDay | String | 20150817 |
包月套餐的结束时间 |
num | String | 5000 |
跨月不清零的调用剩余次数。 |
pointName | String | 快递单号查询 |
接入点名称 |
rate | String | 3次/每秒 |
调用频率限制。 |
ret_code | String | 0 |
状态编码,0为成功,其他为失败 |
... |
{
"showapi_res_code": 0,
"showapi_res_error": "",
"showapi_res_body": {
"apiName": "全国快递查询",
"dayGift": -1,
"money": 0,
"monthDayNum": 0,
"monthEndDay": 0,
"monthStartDay": 0,
"num": 0,
"pointName": "快递单号查询",
"rate": "每秒3次",
"ret_code": 0
}
}