公共参数
| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| 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版本 |
请求参数
请求参数:&contact_name=姓名&province=浙江省&city=杭州市&country=西湖区&town=北山街道&addr=华星路xx号 &zip_code=000000&phoneAreaCode=0790&phone=6711050&mobile_phone=13688889999&is_def=1&auto_clear=0 &token=d42b62b7db6056172687a69c5cb25653
参数说明:token是由小饼干工具返回的token
响应参数
Version: Date:
| 名称 | 类型 | 必须 | 示例值 | 描述 |
|---|---|---|---|---|
| success | String | 0 | true | 成功状态bool值 |
| message | String | 0 | 操作成功 | 返回文字 |
| code | String | 0 | 0 | 返回代码 |
| returnValue | String | 0 | {"deliverId":13619520870} | 返回数据 |
请求示例
-
- -- 请求示例 url 默认请求参数已经URL编码处理
- curl -i "https://api-gw.onebound.cn/taobao/buyer_address_add/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&&contact_name=姓名&province=浙江省&city=杭州市&country=西湖区&town=北山街道&addr=华星路xx号&zip_code=000000&phone=&mobile_phone=13688889999&is_def=1&auto_clear=0"
响应示例
- {
- data: {
- code: "0",
- message: "操作成功",
- returnValue: "{"deliverId":13633678015}",
- success: "true"
- },
- from: "taobao",
- error: "",
- reason: "",
- error_code: "0000",
- cache: 0,
- api_info: "today:41 max:10000",
- execution_time: 0.89,
- server_time: "Beijing/2021-03-17 10:01:18",
- client_ip: "127.0.0.1",
- call_args: {
- contact_name: "姓名",
- province: "浙江省",
- city: "杭州市",
- country: "渝水区",
- town: "北山街道",
- addr: "华星路xx号",
- zip_code: "000000",
- phone: "6711049",
- mobile_phone: "13688889999",
- is_def: "1",
- auto_clear: "0"
- },
- api_type: "taobao",
- translate_language: "zh-CN",
- translate_engine: "google_cn",
- server_memory: "5.52MB",
- request_id: "0.605162ed8df15"
- }
异常示例相关资料错误码解释
| 状态代码(error_code) | 状态信息 | 详细描述 | 是否收费 |
|---|---|---|---|
| 0000 | success | 接口调用成功并返回相关数据 | 是 |
| 2000 | Search success but no result | 接口访问成功,但是搜索没有结果 | 是 |
| 4000 | Server internal error | 服务器内部错误 | 否 |
| 4001 | Network error | 网络错误 | 否 |
| 4002 | Target server error | 目标服务器错误 | 否 |
| 4003 | Param error | 用户输入参数错误 | 忽略 |
| 4004 | Account not found | 用户帐号不存在 | 忽略 |
| 4005 | Invalid authentication credentials | 授权失败 | 忽略 |
| 4006 | API stopped | 您的当前API已停用 | 忽略 |
| 4007 | Account stopped | 您的账户已停用 | 忽略 |
| 4008 | API rate limit exceeded | 并发已达上限 | 忽略 |
| 4009 | API maintenance | API维护中 | 忽略 |
| 4010 | API not found with these values | API不存在 | 忽略 |
| 4012 | Please add api first | 请先添加api | 忽略 |
| 4013 | Number of calls exceeded | 调用次数超限 | 忽略 |
| 4014 | Missing url param | 参数缺失 | 忽略 |
| 4015 | Wrong pageToken | 参数pageToken有误 | 忽略 |
| 4016 | Insufficient balance | 余额不足 | 忽略 |
| 4017 | timeout error | 请求超时 | 否 |
| 5000 | unknown error | 未知错误 | 否 |