开发者接入指南

记账类应用与 AutoAccounting 集成的完整工作流,含 Url Scheme 与 API 同步两种方式。

可通过两种方式接入 AutoAccounting:

  1. 接收账单:提供 Url Scheme,接收识别后的账单推送。
  2. 主动同步:调用开放 API,拉取或推送账本、分类、资产等数据。

方式一:接收账单(Url Scheme)

在记账应用中提供 Url Scheme,处理来自 AutoAccounting 的请求。

请求类型

  1. 记账请求

    包含交易类型、金额、备注等。收到后必须校验参数,确认无误再写入数据库。

  2. 同步账本 / 分类 / 资产

    调用 同步账本同步分类同步资产 将数据推给 AutoAccounting。

  3. 同步报销单

    调用 同步报销单

Tip

最低要求:至少实现记账请求处理,即可满足基本记账。

参数参考

参数名可自定义。传参方式参考已适配应用源码:

AutoAccounting adapter 目录

也可参考 钱迹自动化接口

方式二:API 同步

主动推送或拉取数据时,直接调用本地 HTTP API:

接口说明
同步账本POST /book/put
同步分类POST /category/put
同步资产POST /assets/put
同步报销单POST /bill/book/put
提取待同步账单POST /bill/sync/list
获取设置POST /setting/get

代码健壮性

Caution

AutoAccounting 可能传入异常值。必须做校验,避免脏数据与崩溃。

校验点建议策略
账本存在性默认账本回退
账单存在性覆盖退款、报销场景
分类存在性校验是否属于当前账本;缺失则创建或回退默认分类
金额有效性必须为正数
资产存在性自动创建或拒绝记账

实现选择

无需实现全部接口。仅实现记账接口即可满足基本需求。

自动记账
使用指南 开发者指南 许可证社区 QQ 频道 QQ 群 Telegram 源代码版本信息 更新日志 参与贡献
使用指南 开发者指南 许可证 社区 QQ 频道 QQ 群 Telegram 源代码 版本信息 更新日志 参与贡献 首页