四种开发方式
| 方式 | 是什么 | 在服务器内运行代码? | 您作品的许可证 |
|---|---|---|---|
| 扩展包 | 一个数据文件:工作流规则、报表、单据模板、输入表单设置、编号和仪表板布局 | 否 | 由您决定 |
| 主题 | 一个包含配色和圆角样式的文件 | 否 | 由您决定 |
| 外部应用 | 使用 API 和 webhook 的您自己的程序 | 否,在别处运行 | 由您决定 |
| 核心贡献 | 加入系统本身的 Go 代码 | 是,经审查后 | AGPL v3 |
扩展包、主题和外部应用都无法在他人的安装中运行代码,因此安装它们不会破坏系统,也无法读取未授权的数据。扩展包中的工作流规则在安装时处于关闭状态,安装者会在同意前审查其新增内容。外部应用只能获得其 API 密钥所属用户被允许的权限。
API 和 webhook
- API 密钥代表一个用户,拥有该用户的权限,可设为只读或读写。系统只保存密钥的哈希值,密钥只显示一次。
- 接口位于
/api/v1/之下,涵盖会计科目、联系人、物品、日记账分录、发票、线索和客户关系管理,返回 JSON。 - Webhook 在您选定的页面上每保存一条记录,就发送一个带签名(
X-Signature: sha256=…)的 JSON 请求,失败时重试一次。
文件格式
每个文件都注明其 format 和 version,系统会拒绝无法识别的版本。后续版本只会新增字段;会破坏旧文件的更改将使用新的版本号。
| 文件 | 格式 | 版本 |
|---|---|---|
| 扩展包 | nbs-pack | 1 |
| 主题 | nbs-theme | 1 |
| 合作伙伴之间的贸易单据 | nbs-trade | 1 |
在应用市场发布
每个安装都有一个应用市场,管理员可在其中开关模块,安装扩展包和主题。每个扩展包和主题都以发布者(公司或个人)的名义发布,并附上其名称。我们计划推出汇集其他开发者扩展包和主题的共享目录,以及发布者账户和付费上架。
文档
开发者文档涵盖架构、扩展包、主题、贸易文件、由代码生成参考的 API、webhook 和发布流程。文档采用 Apache 2.0 许可证,您可以在自己的作品中使用其中的示例。详见许可证。