小星记账自 3.5.0 版本开始,支持外部应用通过 URL Scheme 访问小星记账。比如,可通过接口传递明细参数实现快捷记账,也支持传递界面关键字唤起自动记账弹窗。您可以参照下方的接口文档编写适合自己的应用或插件,以实现更定制化的记账需求。
功能入口:主页侧边栏 - 设置 - 扩展功能
在调用接口前,请先在【扩展功能】中开启 URL Scheme 选项。
接口参数
1 记账
通过该接口可实现向小星记账内插入账单明细数据,明细的类别、账户、金额等信息通过参数传递给小星记账。
接口
xxjz://api/create?参数…
支出示例
xxjz://api/create?type=支出&parent=餐饮&child=午餐&amount=10.21&account=余额宝&remark=备注
收入示例
xxjz://api/create?type=收入&child=红包&amount=10.21&account=余额宝&remark=备注
转账示例
xxjz://api/create?type=转账&child=账户互转&amount=10.21&account=余额宝&account2=零钱通&remark=余额宝转零钱通
借贷示例
xxjz://api/create?type=借贷&child=借入&amount=10.21&account=张三&account2=零钱通&remark=向张三借钱
xxjz://api/create?type=借贷&child=还款&amount=10.21&account=零钱通&account2=张三&remark=还钱给张三
完整参数示例
xxjz://api/create?type=支出&parent=餐饮&child=早餐&amount=10.21&account=余额宝8&remark=备注&book=我的账本&tag=标签1 标签2&member=自己:10 孩子:0.21&shop=商家¤cy=人民币&time=2024-12-31 19:00:00
参数
参数 | 名称 | 必填 | 参数说明 |
---|---|---|---|
book | 账本 | 否 | 可填入已有的账本名称,不填则默认记在当前账本 |
type | 类型 | 是 | 必填:支出、收入、转账、借贷 |
time | 时间 | 否 | 时间格式为yyyy-MM-dd HH:mm:ss,不填则默认使用当前时间 |
parent | 大类 | 否 | 填入已有的大类名称。支出类型必填(如果有开启收入大类功能,收入类型也必填),转账与借贷无需填写 |
child | 小类 | 是 | 需填入已有的小类名称。如早餐、红包、账户互转、借入等 |
amount | 金额 | 是 | 填入数字 |
account | 账户 | 是 | 填入已有的账户名称 |
account2 | 账户2 | 否 | 转账与借贷需要填入已有的账户名称,支出与收入无需填写 |
remark | 备注 | 否 | 可填入明细备注 |
member | 角色 | 否 | 对于支出、收入类型,可填入已有的角色名称,不填则使用默认角色。如有多个角色请通过「空格」分开。如果不同角色拥有不用金额,格式为 角色A:10.00 角色B:20.00 |
tag | 标签 | 否 | 可填入标签名称,如有多个标签请通过「空格」分开 |
shop | 商家 | 否 | 可填入商家名称 |
currency | 币种 | 否 | 默认为人民币,如需填写,请填入【币种管理】中币种的中文名称 |
2 唤起自动记账弹窗
通过该接口可实现直接唤起小星记账的自动记账弹窗,在弹窗中选择类别、账户等信息后即可保存明细。
与记账接口不同,该接口无需传入准确的类别、账户等信息,只需提取界面中的关键字传入,弹窗内会依据关键字自动完成对类别、账户等信息的记忆与映射。这通常适用于自动记账未支持的场景,您可以自行获取界面、通知、短信中的关键内容,传递给小星记账以唤起弹窗,进而达成与微信、支付宝等内置场景相同的自动记账效果。
调用该接口时,自动记账服务需处于运行中状态。
接口
xxjz://api/dialog?参数…
示例
xxjz://api/dialog?type=支出&amount=10.21&account=余额宝&remark=备注&shop=测试商店
完整参数示例
xxjz://api/dialog?type=转账&shop=招商银行转账&amount=10.21&account=招商银行储蓄卡&account2=浦发银行储蓄卡&remark=备注&channel=招商银行&time=2024-12-31 19:00:00
参数
参数 | 名称 | 必填 | 参数说明 |
---|---|---|---|
type | 类型 | 否 | 可填入:支出、收入、转账、借贷,默认为支出 |
time | 时间 | 否 | 任意时间格式,如果解析失败或不填则默认使用当前时间 |
amount | 金额 | 否 | 任意金额数字,如果解析失败或不填则默认显示0金额 |
shop | 商户 | 否 | 任意商户名称,建议填写,同一商户名称会记忆上次所选的类别、商家、标签等信息 |
account | 账户 | 否 | 任意账户名称,建议填写,同一账户名称会记忆上次所选的账户 |
account2 | 账户 | 否 | 同上,转账与借贷可填入 |
remark | 备注 | 否 | |
channel | 渠道 | 否 | 渠道名称,可以标记交易渠道,与自动记账中的「自动添加交易渠道标签」对应 |