接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/Add
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.Add
接口描述: 增 添加会员的收货地址,每个会员最多设置20个收货地址。会员可以是小白开放平台的会员,也可以是非小白平台的会员。省、市、区ID可以为空,如有需要可从App.Common_Address.Choose接口获取。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| address_name | 字符串 | 可选 | 最大:200 | 地址别名,例如:家里、公司、学校、父母家 | |
| address_details | 字符串 | 可选 | 最大:1000 | 详细地址,完整的详细地址 | |
| provinces | 整型 | 可选 | 0 | 省份id,可以参考使用App.Common_Address.Choose接口的省份编码 | |
| city | 整型 | 可选 | 0 | 城市id,可以参考使用App.Common_Address.Choose接口的城市编码 | |
| area | 整型 | 可选 | 0 | 区县id,可以参考使用App.Common_Address.Choose接口的区县编码 | |
| zip_code | 字符串 | 可选 | 最大:10 | 邮编 | |
| realname | 字符串 | 可选 | 最大:100 | 真实姓名 | |
| mobile | 字符串 | 可选 | 最大:20 | 手机号码,例如:13800138000 | |
| home_phone | 字符串 | 可选 | 最大:20 | 家庭号码,例如:020-88888888 | |
| 字符串 | 可选 | 最大:100 | 邮箱地址,例如:xxx@yesapi.cn |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7101 添加收货地址接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.Add`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 增 添加会员的收货地址,每个会员最多设置20个收货地址。会员可以是小白开放平台的会员,也可以是非小白平台的会员。省、市、区ID可以为空,如有需要可从App.Common_Address.Choose接口获取。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.Add` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
| address_name | string | 可选 | 地址别名,例如:家里、公司、学校、父母家 |
| address_details | string | 可选 | 详细地址,完整的详细地址 |
| provinces | int | 可选 | 省份id,可以参考使用App.Common_Address.Choose接口的省份编码 |
| city | int | 可选 | 城市id,可以参考使用App.Common_Address.Choose接口的城市编码 |
| area | int | 可选 | 区县id,可以参考使用App.Common_Address.Choose接口的区县编码 |
| zip_code | string | 可选 | 邮编 |
| realname | string | 可选 | 真实姓名 |
| mobile | string | 可选 | 手机号码,例如:13800138000 |
| home_phone | string | 可选 | 家庭号码,例如:020-88888888 |
| email | string | 可选 | 邮箱地址,例如:xxx@yesapi.cn |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功(每个会员最多设置20个收货地址),1表示失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.id | int | 新地址ID,失败时返回0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.Add&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.Add&member_id=888&address_name=公司&address_details=广州天河体育中心&provinces=0&city=0&area=0&realname=张三&mobile=13800138000&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 9
},
"msg": "小白开放接口:App.Market_MemberAddress.Add"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功(每个会员最多设置20个收货地址),1表示失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.id | 整型 | 新地址ID,失败时返回0 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/Edit
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.Edit
接口描述: 改 编辑已有的会员收货地址,参数与添加添加收货地址接口类似。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| id | 整型 | 必须 | 最小:1 | 会员地址ID | |
| address_name | 字符串 | 可选 | 最大:200 | 地址别名,例如:家里、公司、学校、父母家 | |
| address_details | 字符串 | 可选 | 最大:1000 | 详细地址,完整的详细地址 | |
| provinces | 整型 | 可选 | 0 | 省份id,可以参考使用App.Common_Address.Choose接口的省份编码 | |
| city | 整型 | 可选 | 0 | 城市id,可以参考使用App.Common_Address.Choose接口的城市编码 | |
| area | 整型 | 可选 | 0 | 区县id,可以参考使用App.Common_Address.Choose接口的区县编码 | |
| zip_code | 字符串 | 可选 | 最大:10 | 邮编 | |
| realname | 字符串 | 可选 | 最大:100 | 真实姓名 | |
| mobile | 字符串 | 可选 | 最大:20 | 手机号码,例如:13800138000 | |
| home_phone | 字符串 | 可选 | 最大:20 | 家庭号码,例如:020-88888888 | |
| 字符串 | 可选 | 最大:100 | 邮箱地址,例如:xxx@yesapi.cn |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7102 编辑收货地址接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.Edit`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 编辑已有的会员收货地址,参数与添加添加收货地址接口类似。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.Edit` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
| id | int | 必填 | 会员地址ID |
| address_name | string | 可选 | 地址别名,例如:家里、公司、学校、父母家 |
| address_details | string | 可选 | 详细地址,完整的详细地址 |
| provinces | int | 可选 | 省份id,可以参考使用App.Common_Address.Choose接口的省份编码 |
| city | int | 可选 | 城市id,可以参考使用App.Common_Address.Choose接口的城市编码 |
| area | int | 可选 | 区县id,可以参考使用App.Common_Address.Choose接口的区县编码 |
| zip_code | string | 可选 | 邮编 |
| realname | string | 可选 | 真实姓名 |
| mobile | string | 可选 | 手机号码,例如:13800138000 |
| home_phone | string | 可选 | 家庭号码,例如:020-88888888 |
| email | string | 可选 | 邮箱地址,例如:xxx@yesapi.cn |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,会员收货地址不存在,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.Edit&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.Edit&member_id=888&id=9&address_name=公司&address_details=广州天河体育中心&provinces=0&city=0&area=0&realname=张三&mobile=13800138000&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "小白开放接口:App.Market_MemberAddress.Edit"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,会员收货地址不存在,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/SetDefaultByAddressId
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.SetDefaultByAddressId
接口描述: 改 将会员收货地址设置为默认收货地址。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| id | 整型 | 必须 | 最小:1 | 会员地址ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7103 设为默认收货地址接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.SetDefaultByAddressId`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 将会员收货地址设置为默认收货地址。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.SetDefaultByAddressId` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
| id | int | 必填 | 会员地址ID |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.SetDefaultByAddressId&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.SetDefaultByAddressId&member_id=10&id=3&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 0
},
"msg": "小白开放接口:App.Market_MemberAddress.SetDefaultByAddressId"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/SetAlias
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.SetAlias
接口描述: 改 修改会员收货地址别名。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| id | 整型 | 必须 | 最小:1 | 会员地址ID | |
| address_name | 字符串 | 可选 | 最大:200 | 地址别名,例如:家里、公司、学校、父母家 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7104 设置收货地址别名接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.SetAlias`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 改 修改会员收货地址别名。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.SetAlias` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
| id | int | 必填 | 会员地址ID |
| address_name | string | 可选 | 地址别名,例如:家里、公司、学校、父母家 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,会员收货地址不存在,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.SetAlias&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.SetAlias&member_id=10&id=3&address_name=公司&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "小白开放接口:App.Market_MemberAddress.SetAlias"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,会员收货地址不存在,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/GetDefault
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.GetDefault
接口描述: 查 获取默认收货地址接口。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7105 获取默认收货地址接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.GetDefault`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 获取默认收货地址接口。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.GetDefault` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.address | object | 默认收货地址的详情信息,没有时为null|
| data.address.id | int | 收货地址ID|
| data.address.uuid | string | 小白会员UUID|
| data.address.add_time | string | 添加时间,如:2019-10-14 16:18:58|
| data.address.update_time | string | 更新时间,如:2019-10-14 17:07:21|
| data.address.ext_data | object | 扩展数据,没有时为null|
| data.address.member_id | int | 第三方用户id,没有时为0|
| data.address.provinces | int | 省id,没有时为0|
| data.address.city | int | 市id,没有时为0|
| data.address.area | int | 区id,没有时为0|
| data.address.address_name | string | 地址别名|
| data.address.address_details | string | 详细地址|
| data.address.is_default | int | 是否默认地址,1是0不是|
| data.address.zip_code | string | 邮编|
| data.address.realname | string | 真实姓名|
| data.address.home_phone | string | 家庭号码|
| data.address.mobile | string | 手机号码|
| data.address.email | string | 邮箱|
| data.address.provinces_name | string | 省份名,没有时为空字符串|
| data.address.city_name | string | 城市名,没有时为空字符串|
| data.address.area_name | string | 区县名,没有时为空字符串|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.GetDefault&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.GetDefault&member_id=10&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"address": {
"id": 3,
"uuid": "",
"add_time": "2019-10-14 16:18:58",
"update_time": "2019-10-14 17:07:21",
"ext_data": null,
"member_id": 10,
"provinces": 1,
"city": 2,
"area": 3,
"address_name": "phpunit_test",
"address_details": "天河区石牌桥",
"is_default": 1,
"zip_code": 520000,
"realname": "黄先生",
"home_phone": "",
"mobile": "1380001380000",
"yesapi_member_address_status": 1,
"email": "xx@yesapi.cn",
"provinces_name": "",
"city_name": "",
"area_name": ""
}
},
"msg": "小白开放接口:App.Market_MemberAddress.GetDefault"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.address | 对象 | 默认收货地址的详情信息,没有时为null |
| data.address.id | 整型 | 收货地址ID |
| data.address.uuid | 字符串 | 小白会员UUID |
| data.address.add_time | 字符串 | 添加时间,如:2019-10-14 16:18:58 |
| data.address.update_time | 字符串 | 更新时间,如:2019-10-14 17:07:21 |
| data.address.ext_data | 对象 | 扩展数据,没有时为null |
| data.address.member_id | 整型 | 第三方用户id,没有时为0 |
| data.address.provinces | 整型 | 省id,没有时为0 |
| data.address.city | 整型 | 市id,没有时为0 |
| data.address.area | 整型 | 区id,没有时为0 |
| data.address.address_name | 字符串 | 地址别名 |
| data.address.address_details | 字符串 | 详细地址 |
| data.address.is_default | 整型 | 是否默认地址,1是0不是 |
| data.address.zip_code | 字符串 | 邮编 |
| data.address.realname | 字符串 | 真实姓名 |
| data.address.home_phone | 字符串 | 家庭号码 |
| data.address.mobile | 字符串 | 手机号码 |
| data.address.email | 字符串 | 邮箱 |
| data.address.provinces_name | 字符串 | 省份名,没有时为空字符串 |
| data.address.city_name | 字符串 | 城市名,没有时为空字符串 |
| data.address.area_name | 字符串 | 区县名,没有时为空字符串 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/GetDetail
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.GetDetail
接口描述: 查 根据ID获取指定收货地址的详情接口。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| id | 整型 | 必须 | 最小:1 | 会员地址ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7106 获取收货地址详情接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.GetDetail`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 根据ID获取指定收货地址的详情接口。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.GetDetail` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
| id | int | 必填 | 会员地址ID |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.address | object | 收货地址的详情信息,没有时为null|
| data.address.id | int | 收货地址ID|
| data.address.uuid | string | 小白会员UUID|
| data.address.add_time | string | 添加时间,如:2019-10-14 16:18:58|
| data.address.update_time | string | 更新时间,如:2019-10-14 17:07:21|
| data.address.ext_data | object | 扩展数据,没有时为null|
| data.address.member_id | int | 第三方用户id,没有时为0|
| data.address.provinces | int | 省id,没有时为0|
| data.address.city | int | 市id,没有时为0|
| data.address.area | int | 区id,没有时为0|
| data.address.address_name | string | 地址别名|
| data.address.address_details | string | 详细地址|
| data.address.is_default | int | 是否默认地址,1是0不是|
| data.address.zip_code | string | 邮编|
| data.address.realname | string | 真实姓名|
| data.address.home_phone | string | 家庭号码|
| data.address.mobile | string | 手机号码|
| data.address.email | string | 邮箱|
| data.address.provinces_name | string | 省份名,没有时为空字符串|
| data.address.city_name | string | 城市名,没有时为空字符串|
| data.address.area_name | string | 区县名,没有时为空字符串|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.GetDetail&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.GetDetail&member_id=888&id=9&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"address": {
"id": 9,
"uuid": "",
"add_time": "2019-10-14 17:39:16",
"update_time": null,
"ext_data": null,
"member_id": 888,
"provinces": 0,
"city": 0,
"area": 0,
"address_name": "公司",
"address_details": "广州天河体育中心",
"is_default": 0,
"zip_code": 0,
"realname": "张三",
"home_phone": null,
"mobile": "13800138000",
"yesapi_member_address_status": 1,
"email": null,
"provinces_name": "",
"city_name": "",
"area_name": ""
}
},
"msg": "小白开放接口:App.Market_MemberAddress.GetDetail"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.address | 对象 | 收货地址的详情信息,没有时为null |
| data.address.id | 整型 | 收货地址ID |
| data.address.uuid | 字符串 | 小白会员UUID |
| data.address.add_time | 字符串 | 添加时间,如:2019-10-14 16:18:58 |
| data.address.update_time | 字符串 | 更新时间,如:2019-10-14 17:07:21 |
| data.address.ext_data | 对象 | 扩展数据,没有时为null |
| data.address.member_id | 整型 | 第三方用户id,没有时为0 |
| data.address.provinces | 整型 | 省id,没有时为0 |
| data.address.city | 整型 | 市id,没有时为0 |
| data.address.area | 整型 | 区id,没有时为0 |
| data.address.address_name | 字符串 | 地址别名 |
| data.address.address_details | 字符串 | 详细地址 |
| data.address.is_default | 整型 | 是否默认地址,1是0不是 |
| data.address.zip_code | 字符串 | 邮编 |
| data.address.realname | 字符串 | 真实姓名 |
| data.address.home_phone | 字符串 | 家庭号码 |
| data.address.mobile | 字符串 | 手机号码 |
| data.address.email | 字符串 | 邮箱 |
| data.address.provinces_name | 字符串 | 省份名,没有时为空字符串 |
| data.address.city_name | 字符串 | 城市名,没有时为空字符串 |
| data.address.area_name | 字符串 | 区县名,没有时为空字符串 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_MemberAddress/GetList
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_MemberAddress.GetList
接口描述: 查 获取收货地址列表接口,每个会员最多设置20个收货地址。排序顺序是,默认地址在最前面,然后按最近更新时间降序排序。使用前请先安装会员收货地址插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| member_id | 字符串 | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7107 获取收货地址列表接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_MemberAddress.GetList`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 查 获取收货地址列表接口,每个会员最多设置20个收货地址。排序顺序是,默认地址在最前面,然后按最近更新时间降序排序。使用前请先安装会员收货地址插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_MemberAddress.GetList` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| member_id | string | 可选 | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:无uuid且无member_id:不绑定任何会员有uuid无member_id:绑定小白开放平台会员体系无uuid有member_id:绑定第三方会员体系有uuid且有member_id:既绑定uuid又绑定member_id |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.address_list | array | 收货地址的详情信息,没有时为空数组|
| data.address_list[].id | int | 收货地址ID|
| data.address_list[].uuid | string | 小白会员UUID|
| data.address_list[].add_time | string | 添加时间,如:2019-10-14 16:18:58|
| data.address_list[].update_time | string | 更新时间,如:2019-10-14 17:07:21|
| data.address_list[].ext_data | object | 扩展数据,没有时为null|
| data.address_list[].member_id | int | 第三方用户id,没有时为0|
| data.address_list[].provinces | int | 省id,没有时为0|
| data.address_list[].city | int | 市id,没有时为0|
| data.address_list[].area | int | 区id,没有时为0|
| data.address_list[].address_name | string | 地址别名|
| data.address_list[].address_details | string | 详细地址|
| data.address_list[].is_default | int | 是否默认地址,1是0不是|
| data.address_list[].zip_code | string | 邮编|
| data.address_list[].realname | string | 真实姓名|
| data.address_list[].home_phone | string | 家庭号码|
| data.address_list[].mobile | string | 手机号码|
| data.address_list[].email | string | 邮箱|
| data.address_list[].provinces_name | string | 省份名,没有时为空字符串|
| data.address_list[].city_name | string | 城市名,没有时为空字符串|
| data.address_list[].area_name | string | 区县名,没有时为空字符串|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_MemberAddress.GetList&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?s=App.Market_MemberAddress.GetList&member_id=10&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"address_list": [
{
"id": 3,
"uuid": "",
"add_time": "2019-10-14 16:18:58",
"update_time": "2019-10-14 17:07:21",
"ext_data": null,
"member_id": 10,
"provinces": 1,
"city": 2,
"area": 3,
"address_name": "phpunit_test",
"address_details": "天河区石牌桥",
"is_default": 1,
"zip_code": 520000,
"realname": "黄先生",
"home_phone": "",
"mobile": "1380001380000",
"yesapi_member_address_status": 1,
"email": "xx@yesapi.cn",
"provinces_name": "",
"city_name": "",
"area_name": ""
},
{
"id": 4,
"uuid": "",
"add_time": "2019-10-14 16:35:40",
"update_time": "2019-10-14 16:35:40",
"ext_data": null,
"member_id": 10,
"provinces": 11,
"city": 1101,
"area": 0,
"address_name": "家里",
"address_details": "天河区石牌桥1571042140",
"is_default": 0,
"zip_code": 520000,
"realname": "黄先生",
"home_phone": "",
"mobile": "138000138000",
"yesapi_member_address_status": 1,
"email": "xx@yesapi.cn",
"provinces_name": "北京市",
"city_name": "市辖区",
"area_name": ""
},
{
"id": 1,
"uuid": "",
"add_time": "2019-10-14 16:16:27",
"update_time": null,
"ext_data": null,
"member_id": 10,
"provinces": 1,
"city": 2,
"area": 3,
"address_name": "家里",
"address_details": "天河区石牌桥",
"is_default": 0,
"zip_code": 520000,
"realname": "黄先生",
"home_phone": "",
"mobile": "1380001380000",
"yesapi_member_address_status": 1,
"email": "xx@yesapi.cn",
"provinces_name": "",
"city_name": "",
"area_name": ""
}
]
},
"msg": "小白开放接口:App.Market_MemberAddress.GetList"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1表示失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.address_list | 字符串 | 收货地址的详情信息,没有时为空数组 |
| data.address_list[].id | 整型 | 收货地址ID |
| data.address_list[].uuid | 字符串 | 小白会员UUID |
| data.address_list[].add_time | 字符串 | 添加时间,如:2019-10-14 16:18:58 |
| data.address_list[].update_time | 字符串 | 更新时间,如:2019-10-14 17:07:21 |
| data.address_list[].ext_data | 对象 | 扩展数据,没有时为null |
| data.address_list[].member_id | 整型 | 第三方用户id,没有时为0 |
| data.address_list[].provinces | 整型 | 省id,没有时为0 |
| data.address_list[].city | 整型 | 市id,没有时为0 |
| data.address_list[].area | 整型 | 区id,没有时为0 |
| data.address_list[].address_name | 字符串 | 地址别名 |
| data.address_list[].address_details | 字符串 | 详细地址 |
| data.address_list[].is_default | 整型 | 是否默认地址,1是0不是 |
| data.address_list[].zip_code | 字符串 | 邮编 |
| data.address_list[].realname | 字符串 | 真实姓名 |
| data.address_list[].home_phone | 字符串 | 家庭号码 |
| data.address_list[].mobile | 字符串 | 手机号码 |
| data.address_list[].email | 字符串 | 邮箱 |
| data.address_list[].provinces_name | 字符串 | 省份名,没有时为空字符串 |
| data.address_list[].city_name | 字符串 | 城市名,没有时为空字符串 |
| data.address_list[].area_name | 字符串 | 区县名,没有时为空字符串 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次