YesApi 接口文档

7101 添加收货地址接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/Add

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.Add

接口描述： 增 添加会员的收货地址，每个会员最多设置20个收货地址。会员可以是小白开放平台的会员，也可以是非小白平台的会员。省、市、区ID可以为空，如有需要可从App.Common_Address.Choose接口获取。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有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
email字符串可选最大：100邮箱地址，例如：xxx@yesapi.cn

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7102 编辑收货地址接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/Edit

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.Edit

接口描述： 改 编辑已有的会员收货地址，参数与添加添加收货地址接口类似。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有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
email字符串可选最大：100邮箱地址，例如：xxx@yesapi.cn

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7103 设为默认收货地址接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/SetDefaultByAddressId

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.SetDefaultByAddressId

接口描述： 改 将会员收货地址设置为默认收货地址。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有member_id：既绑定uuid又绑定member_id
id整型必须最小：1会员地址ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7104 设置收货地址别名接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/SetAlias

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.SetAlias

接口描述： 改 修改会员收货地址别名。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有member_id：既绑定uuid又绑定member_id
id整型必须最小：1会员地址ID
address_name字符串可选最大：200地址别名，例如：家里、公司、学校、父母家

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7105 获取默认收货地址接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/GetDefault

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.GetDefault

接口描述： 查 获取默认收货地址接口。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有member_id：既绑定uuid又绑定member_id

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7106 获取收货地址详情接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/GetDetail

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.GetDetail

接口描述： 查 根据ID获取指定收货地址的详情接口。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有member_id：既绑定uuid又绑定member_id
id整型必须最小：1会员地址ID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7107 获取收货地址列表接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_MemberAddress/GetList

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_MemberAddress.GetList

接口描述： 查 获取收货地址列表接口，每个会员最多设置20个收货地址。排序顺序是，默认地址在最前面，然后按最近更新时间降序排序。使用前请先安装会员收货地址插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
member_id字符串可选会员ID，可以使用小白开放平台的会员体系（即传递uuid+token），或者使用第三方平台的会员体系（即需要自定义指定member_id），这两者应提供至少其中一种，以免无法与会员对应关联。若uuid和member_id均未提供，则不关联会员；若两者都提供，则两者都会进行同时匹配关联。即分为以下四种情况：
  1. 无uuid且无member_id：不绑定任何会员
  2. 有uuid无member_id：绑定小白开放平台会员体系
  3. 无uuid有member_id：绑定第三方会员体系
  4. 有uuid且有member_id：既绑定uuid又绑定member_id

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次