Appearance
开放自动记账API
自动记账API为提供了一个基于HTTP的API调用,允许开发者通过发送和接收JSON对象来实现与发发记账APP进行数据交互,以便实现自动记账功能。
JSON是一种开放的标准数据格式,它是轻量级的,而且是人类可读的。
当向API发送内容或请求时,响应将以JSON形式返回,这使开发人员能够从客户端 JavaScript 或外部应用程序创建、读取和更新数据库信息,API可以使用任何编程语言进行调用。
我们提供了两个接口,实现外部软件接入API后实现自动记账。
| 操作 | 请求 | 地址 | 操作 |
|---|---|---|---|
| 登录并获取设置信息 | POST | www.88jizhang.com:3009/autoapi/login | 登录并获取设置信息 |
| 记账 | POST | www.88jizhang.com:3009/autoapi/autojizhang | 记账 |
一、登录获取相关账本信息API 通过请求地址,传递用户账号、密码、apikey共三个参数,后端返回自动记账的相关参数信息。后端返回token、账本名称、记账设置的所有参数信息。
1-请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户登录名 |
| password | string | 是 | 用户登录密码 |
| apikey | string | 是 | 为每个开发者设置唯一的key,以便系统识别和管理,需联系发发记账管理员申请 |
2-返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| status | number | 返回后端登录状态 |
| 返回值5001或5002或5003 | 返回值5001或5002或5003 | 返回值5001或5002或5003 |
| message | string | 5001 用户名不存在 |
| 5002 登录成功 | 5002 登录成功 | 5002 登录成功 |
| 5003 用户名或密码错误 | 5003 用户名或密码错误 | 5003 用户名或密码错误 |
| token | string | 返回token |
| nicheng | string | 用户昵称 |
| zhangbenname | string | 当前使用账本名称 |
| classlists | object | 返回一个对象,当前使用账本的相关设置内容,用于记账时候选择相关参数。普通账户列表,债权债务账户列表,收入类别、支出类别、商家名称列表、成员名称列表,项目名称列表(与发发记账APP中的“我的”菜单下的“记账设置”一致) |
二、记账 通过请求地址,传递用户记账相关的参数信息。后端返回是否记账成功
1-请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mytoken | string | 是 | 传递token(后端会根据token判断用户及用户的当前账本) |
| type | string | 是 | 支出、收入、转账、借入、借出、还款、收债 |
| zhiclass | string | 是 | 支出类别名称 |
| shouclass | string | 是 | 收入类别名称 |
| number | number | 是 | 金额(必须为数字且必须为正数,后端会根据不同收支类型自动处理正负问题) |
| zhuzhanghu | string | 是 | 主账户 |
| liuzhanghu | string | 是 | 流向账户(当为收入、支出、转账类别时候,可不传递该参数) |
| chengyuan | string | 是 | 成员名称 |
| shangjia | string | 是 | 商家名称 |
| xiangmu | string | 是 | 项目名称 |
| beizhu | string | 是 | 备注信息 |
2-返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| status | number | 返回状态码200、2001-2006、2008 |
| message | string | 200 采集入库成功 |
| 2001 找不到主账户 | ||
| 2002 找不到流向账户 | ||
| 2003 找不到支出类别 | ||
| 2004 找不到收入类别 | ||
| 2005 金额不能为负数 | ||
| 2006 两个账户不能相同 | ||
| 2008 采集失败 |
