跳到主要内容

Cloud Functions API

RentHub 小程序与后台所依赖的云函数接口说明:按云函数域划分模块,正文来自业务仓库 docs/api_docs,在文档站统一托管便于检索与分享。

目录

文档说明
api-spec模块文档结构与写作格式
common-error-codes错误响应与 RH 报错码表
user云函数 user
order云函数 order
asset云函数 asset
experience云函数 experience
message云函数 message
newbie云函数 newbie
breach云函数 breach
insurance云函数 insurance
review云函数 review
referral云函数 referral
help云函数 help
preload云函数 preload
sfexpress云函数 sfexpress
scheduler云函数 scheduler
admin云函数 admin
seller-home商家展示相关接口
dispute争议与协商(部分能力在 message

目标

读完本专题,你应当能够:

  • 按云函数名与 action 查阅请求/响应与错误码引用关系;
  • 在《通用报错码》中定位 RH 码含义;
  • 按《API 文档规范》新增或修订接口说明。

通用约定

本节摘录自业务仓库 docs/README.md,与云函数实现对齐。

  • 入参event = { action: string, data?: object },部分云函数仅用 event 原始参数(如 preload)。
  • 出参:业务接口统一返回 { success: boolean, data?: any, message?: string };预拉取返回 JSON 字符串。
  • 鉴权:需登录的 action 依赖云函数内 cloud.getWXContext().OPENID,未登录会返回「用户身份验证失败,请重新登录」。

模块与云函数索引

云函数名API 文档
用户useruser
订单orderorder
资产与展示assetasset
经验与信用experienceexperience
消息与客服messagemessage
成长与任务newbienewbie
违约与处罚breachbreach
保险与理赔insuranceinsurance
评价reviewreview
推荐奖励referralreferral
帮助与配置helphelp
预拉取preloadpreload
物流sfexpresssfexpress
定时任务schedulerscheduler
管理端adminadmin

维护说明

  • 正文修订仍在业务仓库 renthub-mini-programdocs/api_docs 进行;同步到文档站时可复制 Markdown 后执行 node scripts/prepare-api-docs.mjs(勿覆盖手工维护的 index.md)。
  • 功能说明类长文(如预拉取、定时任务配置)仍在业务仓库 docs/functionality_docs