接口

接口概述

接口目录结构

项目API接口文件主要集中在src/app/api/目录下，按功能模块进行分类：

src/app/api/
├── auth.ts         # 认证相关接口
├── diy.ts          # 自定义页面相关接口
├── diy_form.ts     # 自定义表单相关接口
├── friendspay.ts   # 帮付相关接口
├── member.ts       # 会员相关接口
├── pay.ts          # 支付相关接口
├── system.ts       # 系统相关接口
└── verify.ts       # 核销相关接口

API模块分类与接口详解

认证模块 (auth.ts)

认证模块提供了用户登录、注册、登出等认证相关的接口。

登录接口

// 用户名登录
export function usernameLogin(data: AnyObject)
// 手机验证码登录
export function mobileLogin(data: AnyObject)
// 微信公众号授权信息登录
export function wechatUserLogin(data: AnyObject)
// 微信公众号授权登录
export function wechatLogin(data: AnyObject)
// 微信小程序授权登录
export function weappLogin(data: AnyObject)
// 微信app授权登录
export function wxappLogin(data: AnyObject)

注册接口

// 用户名注册
export function usernameRegister(data: AnyObject)
// 手机号注册
export function mobileRegister(data: AnyObject)

其他认证接口

// 获取登录配置
export function getConfig(params: Record<string, any>)
// 退出登录
export function logout()
// 绑定手机号
export function bind(data: AnyObject)
// 记录会员访问日志
export function memberLog(data: AnyObject)
// 修改微信openid相关接口
export function updateWechatOpenid(data: AnyObject)
export function updateWechatOpenidByH5(data: AnyObject)
export function updateWeappOpenid(data: AnyObject)

会员模块 (member.ts)

会员模块提供了会员信息管理、积分余额查询、提现等功能接口。

会员信息接口

// 获取会员信息
export function getMemberInfo()
// 会员信息修改
export function modifyMember(data: AnyObject)
// 登录会员绑定手机号
export function bindMobile(data: AnyObject)
// 获取手机号
export function getMobile(data: AnyObject)

账户资产接口

// 获取积分流水
export function getPointList(data: AnyObject)
// 获取积分来源用途
export function getPointType(account_type: string)
// 获取不可提现余额流水
export function getBalanceList(data: AnyObject)
// 获取余额流水,条件获取
export function getBalanceListAll(data: AnyObject)
// 获取可提现余额流水
export function getMoneyList(data: AnyObject)
// 佣金账户流水
export function getMemberCommission(data: AnyObject)
// 佣金列表
export function getCommissionList(data: AnyObject)
// 获取账号变动类型
export function getAccountType(params: Record<string, any>)

提现相关接口

// 提现转账方式
export function cashOutTransferType()
// 提现配置
export function cashOutConfig()
// 申请余额提现
export function cashOutApply(data: AnyObject)
// 获取提现记录列表
export function getCashOutList(data: AnyObject)
// 获取提现记录详情
export function getCashOutDetail(id: number)
// 会员取消提现
export function memberCancel(params: Record<string, any>)

提现账户接口

// 获取提现账户信息
export function getCashoutAccountInfo(data: AnyObject)
// 获取首条提现账户信息
export function getFirstCashOutAccountInfo(data: AnyObject)
// 获取提现账户列表
export function getCashOutAccountList(data: AnyObject)
// 添加提现账户
export function addCashoutAccount(data: AnyObject)
// 编辑提现账户
export function editCashoutAccount(data: AnyObject)
// 删除提现账户
export function deleteCashoutAccount(accountId: number)

收货地址接口

// 获取会员收货地址列表
export function getAddressList(params: Record<string, any>)
// 获取会员收货地址详情
export function getAddressInfo(id: number)

支付模块 (pay.ts)

支付模块提供了支付相关的接口。

// 支付
export function pay(data: AnyObject)
// 获取支付信息
export function getPayInfo(tradeType: string, tradeId: number, params: Record<string, any>)

系统模块 (system.ts)

系统模块提供了系统级别的通用接口，如验证码、短信、文件上传等。

验证码与短信接口

// 获取验证码
export function getCaptcha()
// 发送短信验证码
export function sendSms(data: AnyObject)

文件上传接口

// 上传图片
export function uploadImage(data: AnyObject)
// 拉取图片
export function fetchImage(data: AnyObject)
// 拉取base64图片
export function fetchBase64Image(data: AnyObject)
// 上传视频
export function uploadVideo(data: AnyObject)

微信相关接口

// 获取微信公众号授权码
export function getWechatAuthCode(data: AnyObject)
// 同步微信信息
export function wechatSync(data: AnyObject)
// 获取微信jssdk config
export function getWechatSdkConfig(data: AnyObject)
// 获取微信小程序订阅消息模板id
export function getWeappTemplateId(keys: string)
// 通过外部交易号获取消息跳转路径
export function getMsgJumpPath(params: Record<string, any>)

地址相关接口

// 获取下级地址列表
export function getAreaListByPid(pid: number = 0)
// 获取地址树列表
export function getAreatree(level: number = 1)
// 获取地址
export function getAreaByCode(code: number | string)
// 通过经纬度查询地址
export function getAddressByLatlng(params: Record<string, any>)

其他系统接口

// 获取协议信息
export function getAgreementInfo(key: string)
// 重置密码
export function resetPassword(data: AnyObject)
// 获取站点信息
export function getSiteInfo()
// 获取海报
export function getPoster(params: Record<string, any>)
// 获取地图设置
export function getMap()
// 获取初始化数据信息
export function getInitInfo(params: Record<string, any>)
// 获取是否绑定手机号
export function getMemberMobileExist(params: Record<string, any>)
// 获取最新版本信息
export function getNewVersion(params: Record<string, any>)

自定义模块 (diy.ts)

自定义模块提供了自定义页面相关的接口。

// 获取自定义页面信息
export function getDiyInfo(params: Record<string, any>)
// 获取底部导航列表
export function getTabbarList(params: Record<string, any>)
// 获取页面分享信息
export function getShareInfo(params: Record<string, any>)
// 获取个人资料表单
export function getMemberFormRecord()

自定义表单模块 (diy_form.ts)

自定义表单模块提供了自定义表单相关的接口。

// 获取自定义表单信息
export function getDiyFormInfo(params: Record<string, any>)
// 提交表单数据
export function addFormRecord(params: Record<string, any>)
// 提交表单数据【编辑】
export function editFormRecord(params: Record<string, any>)
// 获取表单填写结果信息
export function getFormResultInfo(params: Record<string, any>)
// 获取表单填写记录
export function getFormRecord(params: Record<string, any>)

帮付模块 (friendspay.ts)

帮付模块提供了好友代付相关的接口。

// 获取帮付信息
export function getFriendspayInfo(tradeType: string, tradeId: number)

核销模块 (verify.ts)

核销模块提供了核销相关的接口。

// 获取核销信息
export function getVerifyCode(type: string, params: AnyObject)
// 获取核销记录
export function getVerifyRecords(params: Record<string, any>)
// 判断是否是核销员
export function getCheckVerifier()
// 获取核销信息
export function getVerifierInfo(params: Record<string, any>)
// 核销
export function verify(code: string)
// 获取核销详情
export function getVerifyDetail(code: string)

API使用规范

导入方式

// 导入整个模块
import * as authApi from '@/app/api/auth'
// 导入单个接口
import { usernameLogin, mobileLogin } from '@/app/api/auth'

调用方式

// 调用示例
usernameLogin({ username: 'admin', password: '123456' })
    .then(res => {
        // 处理成功结果
        console.log('登录成功', res)
    })
    .catch(err => {
        // 处理失败结果
        console.error('登录失败', err)
    })

参数配置

// 自定义错误提示配置
usernameLogin({ username: 'admin', password: '123456' }, {
    showErrorMessage: false,  // 不显示错误提示
    showSuccessMessage: true  // 显示成功提示
})