# 软猫引擎API开放平台

## Docs
- 用户基础API > 用户配置 [配置Key说明](https://ruanmao.apifox.cn/7855744m0.md): 
- 系统功能API [功能Key说明](https://ruanmao.apifox.cn/7858001m0.md): 

## API Docs
- 接口安全API(必看) [获取AccessToken](https://ruanmao.apifox.cn/390572724e0.md): AccessToken是其它所有API接口的通讯临时票据（均在其它API接口请求头header["AccessToken"]传入）
- 用户基础API > 获取永久用户标识 [获取永久用户标识UserId（根据临时用户标识userCode）](https://ruanmao.apifox.cn/390914237e0.md): 根据临时用户标识userCode获取永久用户标识userId
- 用户基础API > 获取永久用户标识 [获取永久用户标识UserId（根据已注册的手机号码）](https://ruanmao.apifox.cn/390915306e0.md): 根据已注册的手机号码phone获取永久用户标识userId
- 用户基础API > 用户登录/退出 [发送短信验证码（用户登录）](https://ruanmao.apifox.cn/390915328e0.md): 
- 用户基础API > 用户登录/退出 [用户登录（通过短信验证码）](https://ruanmao.apifox.cn/390915720e0.md): 
- 用户基础API > 用户登录/退出 [用户登录（通过密码）](https://ruanmao.apifox.cn/390917026e0.md): 注意：一般情况下该接口的vcode参数无需传入，但当密码错误次数过多时，最后一次密码如果正确，将触发风控机制，该API接口将返回{code:10020,codeEn:"LoginNeedVCode",msg:"因密码错误次数过多，本次登录需通过短信验证码验证安全性"}，此时重新调用该接口并传入vcode参数即可
- 用户基础API > 用户登录/退出 [用户退出登录](https://ruanmao.apifox.cn/391587338e0.md): 用户退出登录后，临时用户标识userCode将被注销失效
- 用户基础API > 用户注册 [发送短信验证码（用户注册）](https://ruanmao.apifox.cn/390915351e0.md): 
- 用户基础API > 用户注册 [上传用户头像（用户注册）](https://ruanmao.apifox.cn/393296456e0.md): 单个图片文件不能超过20M，该API接口将自动把图片居中裁剪并压缩为280px*280px
- 用户基础API > 用户注册 [用户注册](https://ruanmao.apifox.cn/390915743e0.md): 
- 用户基础API > 修改用户登录密码 [发送短信验证码(修改用户登录密码)](https://ruanmao.apifox.cn/390915357e0.md): 
- 用户基础API > 修改用户登录密码 [修改用户登录密码](https://ruanmao.apifox.cn/390915933e0.md): 
- 用户基础API > 修改用户安全密码 [发送短信验证码(修改用户安全密码)](https://ruanmao.apifox.cn/390916958e0.md): 注意：【用户安全密码】区别于【用户登录密码】，【用户安全密码】常用于发起余额支付、提现等用途
- 用户基础API > 修改用户安全密码 [修改用户安全密码](https://ruanmao.apifox.cn/390916982e0.md): 注意：【用户安全密码】区别于【用户登录密码】，【用户安全密码】常用于发起余额支付、提现等用途
- 用户基础API > 修改用户手机号码 [发送短信验证码(修改用户手机号码-新手机号码)](https://ruanmao.apifox.cn/391395742e0.md): 
- 用户基础API > 修改用户手机号码 [发送短信验证码(修改用户手机号码-原手机号码)](https://ruanmao.apifox.cn/391379940e0.md): 仅当【用户配置OrgnVerCodeForPhoneUpdate=`1`】时需要调用该API接口
- 用户基础API > 修改用户手机号码 [修改用户手机号码](https://ruanmao.apifox.cn/391379941e0.md): 调用该API接口之前，请先调用【用户配置->读取用户配置】接口获取用户配置OrgnVerCodeForPhoneUpdate，判断是否需要提供原手机号码的短信验证码
- 用户基础API > 用户资料 [获取用户资料](https://ruanmao.apifox.cn/393302600e0.md): 
- 用户基础API > 用户资料 [获取用户等级](https://ruanmao.apifox.cn/393338441e0.md): 必须开通【等级系统Grade】才能调用该API接口，否则返回错误，可通过【系统功能API->验证是否已开通指定功能】接口判断是否已开通【等级系统Grade】
- 用户基础API > 用户资料 [获取用户职称](https://ruanmao.apifox.cn/393339206e0.md): 必须开通【职称系统UserTitle】才能调用该API接口，否则返回错误，可通过【系统功能API->验证是否已开通指定功能】接口判断是否已开通【等级系统UserTitle】
- 用户基础API > 用户资料 [设置用户头像](https://ruanmao.apifox.cn/393352605e0.md): 单个图片文件不能超过20M，该API接口将自动把图片居中裁剪并压缩为280px*280px
- 用户基础API > 用户资料 [设置用户昵称](https://ruanmao.apifox.cn/393359731e0.md): 
- 用户基础API > 用户资料 [设置用户性别](https://ruanmao.apifox.cn/393370752e0.md): 
- 用户基础API > 用户资料 [设置用户所在地](https://ruanmao.apifox.cn/393373484e0.md): 
- 用户基础API > 用户配置 [读取用户配置](https://ruanmao.apifox.cn/391221502e0.md): 
- 用户基础API > 用户配置 [批量读取用户配置](https://ruanmao.apifox.cn/391271448e0.md): 
- 用户基础API > 用户配置 [修改用户配置](https://ruanmao.apifox.cn/391307067e0.md): 
- 用户收件地址API [获取用户的收件地址列表](https://ruanmao.apifox.cn/394427620e0.md): 
- 用户收件地址API [获取用户的收件地址（根据id获取）](https://ruanmao.apifox.cn/394428365e0.md): 
- 用户收件地址API [添加用户收件地址](https://ruanmao.apifox.cn/394429598e0.md): 
- 用户收件地址API [修改用户收件地址](https://ruanmao.apifox.cn/394429831e0.md): 
- 用户收件地址API [删除用户收件地址](https://ruanmao.apifox.cn/394430050e0.md): 
- 用户收件地址API [设置默认用户收件地址](https://ruanmao.apifox.cn/394430238e0.md): 
- 用户资产API > 用户银行卡 [获取支持的银行列表](https://ruanmao.apifox.cn/393802946e0.md): 请本地缓存该接口返回的数据
- 用户资产API > 用户银行卡 [验证银行卡号是否正确](https://ruanmao.apifox.cn/393803044e0.md): 请本地缓存该接口返回的数据
- 用户资产API > 用户银行卡 [绑定用户银行卡](https://ruanmao.apifox.cn/393804169e0.md): 调用该API接口之前，建议先调用【用户资产API->用户银行卡->验证银行卡号是否正确】API接口进行预验证
- 用户资产API > 用户银行卡 [解绑用户银行卡](https://ruanmao.apifox.cn/393804552e0.md): 
- 用户资产API > 用户银行卡 [获取已绑定的用户银行卡列表](https://ruanmao.apifox.cn/393804230e0.md): 
- 文件API [上传临时图片文件](https://ruanmao.apifox.cn/390795799e0.md): 单个图片文件不能超过4M
- 文件API [上传临时视频文件](https://ruanmao.apifox.cn/390797201e0.md): 单个视频文件不能超过50M
- 文件API [上传临时音频文件](https://ruanmao.apifox.cn/390797290e0.md): 单个音频文件不能超过20M
- 系统功能API [获取所有已开通的功能列表](https://ruanmao.apifox.cn/391587745e0.md): 
- 系统功能API [验证是否已开通指定功能](https://ruanmao.apifox.cn/391587755e0.md): 
- 行政区划API [获取省市区树](https://ruanmao.apifox.cn/391588397e0.md): 请本地缓存该接口返回的数据
- 行政区划API [获取省份列表(一级行政区划)](https://ruanmao.apifox.cn/391588384e0.md): 请本地缓存该接口返回的数据
- 行政区划API [获取城市列表(二级行政区划)](https://ruanmao.apifox.cn/391588392e0.md): 请本地缓存该接口返回的数据
- 行政区划API [获取区/县/镇列表(三级行政区划)](https://ruanmao.apifox.cn/391588393e0.md): 请本地缓存该接口返回的数据
- 收银台API [获取订单支付句柄（用于发起支付）](https://ruanmao.apifox.cn/394555563e0.md): 1）该接口用于对订单发起付款，所以仅支持对未付款的订单生效；
- 收银台API [发起余额支付](https://ruanmao.apifox.cn/394556626e0.md): #### 特别注意
- 收银台API [发起积分支付](https://ruanmao.apifox.cn/394557213e0.md): #### 特别注意
- 收银台API [发起代币支付](https://ruanmao.apifox.cn/394557236e0.md): #### 特别注意
- 收银台API [判断是否已开通微信支付](https://ruanmao.apifox.cn/394554976e0.md): 
- 收银台API [发起微信支付](https://ruanmao.apifox.cn/394557908e0.md): 
- 收银台API [判断(微信支付)订单是否已付款](https://ruanmao.apifox.cn/394556469e0.md): 该接口常用于轮训查询，建议轮训时间周期为2秒
- 收银台API [判断订单是否已付款](https://ruanmao.apifox.cn/394557509e0.md): 该接口常用于轮训查询，建议轮训时间周期为2秒

## Schemas
- [标准响应模型](https://ruanmao.apifox.cn/227470079d0.md): 
- [用户银行卡数据模型](https://ruanmao.apifox.cn/230743688d0.md): 
- [用户收件地址数据模型](https://ruanmao.apifox.cn/230745332d0.md):