首页 › 帮助文档

帮助文档与开放接口

从开通试用到对接自有系统,这里都写清楚了。文档里找不到答案的,工作日随时打 0571-8823-6190,或者在控制台提工单。

快速上手

新客户从注册到把第一批数据跑起来,一般是下面四步,全程不需要我们介入也能完成。

  1. 注册账号:用手机号注册,收到验证码即可登录控制台,不需要绑定支付方式。
  2. 开通试用:在产品列表里选中要用的产品,点「免费试用」,14 天试用环境即时开通,功能与正式版一致。
  3. 导入基础数据:在「数据管理 - 导入」下载对应模板,填好后上传。系统会先做格式校验,有问题会逐行标出来。
  4. 邀请成员:在「组织架构」里添加部门与成员,分配角色后成员会收到短信邀请,自己设密码即可登录。

试用期最后 3 天系统会提醒续订。正式订阅后试用期产生的数据全部保留,不需要重新配置。

账号与权限

平台按「角色 + 数据范围」两层控制权限,角色决定能做什么,数据范围决定能看到谁的数据。

角色可执行操作默认数据范围
超级管理员全部功能,含订阅管理、成员管理、账单与发票全公司
部门管理员本部门业务数据的增删改查,可审批、可导出本部门及下级
普通成员本人经手业务的录入与查看,可提交审批本人
只读访客仅查看被授权的报表与看板,不能导出按授权指定

超级管理员可以自定义角色,把功能权限拆到按钮级别。企业版支持对接企业微信、钉钉或 LDAP 做单点登录和组织架构自动同步。

数据导入与迁移

自助导入

每个模块都提供 Excel 模板,字段带示例和填写说明。上传后先进入预校验,错误行会标红并给出原因,修正后可只补传错误部分。单次最多 5 万行。

从旧系统迁移

常见的用友 U8、金蝶 K/3、管家婆辉煌版导出文件都有现成的字段映射规则。专业版及以上由实施顾问带做,流程是:

  1. 导出旧系统数据(我们提供导出操作指引)
  2. 字段映射确认,特殊字段单独约定规则
  3. 测试环境试迁移,双方核对抽样数据
  4. 正式迁移,旧系统并行运行 1-2 周后停用

一般规模的迁移 3-10 个工作日完成。历史数据量超过 500 万行的,建议只迁近两年的明细,更早的数据做归档查询。

API 概览与鉴权

专业版及以上开放 REST API。所有接口走 HTTPS,请求与响应均为 JSON,字符集 UTF-8。

项目说明
接口根地址https://api.dzdzhineng.top/v1
沙箱地址https://sandbox-api.dzdzhineng.top/v1
鉴权方式AppKey + AppSecret 签名,签名放在请求头 X-Dz-Sign
时间戳请求头 X-Dz-Timestamp,与服务器时间相差超过 5 分钟拒绝
调用频率专业版 60 次/秒,企业版 300 次/秒,超出返回 429
分页参数 page(从 1 开始)与 page_size(最大 200)

AppKey 与 AppSecret 在控制台「开发者中心 - 应用管理」创建,一个企业最多创建 10 个应用,AppSecret 只在创建时完整显示一次。

接口列表

方法路径用途
GET/org/departments获取部门树
GET/org/members获取成员列表,支持按部门筛选
POST/org/members批量新增或更新成员
GET/data/records按模块与时间范围拉取业务单据
POST/data/records写入业务单据,支持幂等键
GET/report/metrics获取看板指标数值
POST/webhook/subscribe订阅事件回调(单据变更、审批结果等)
GET/account/subscription查询当前订阅与剩余额度

请求示例

以拉取近 7 天的业务单据为例:

# 签名 = HMAC-SHA256(AppSecret, 时间戳 + 请求路径) curl -X GET "https://api.dzdzhineng.top/v1/data/records?module=order&start=2026-09-12&end=2026-09-19&page=1&page_size=100" \ -H "X-Dz-AppKey: dz_live_8f3c21a9" \ -H "X-Dz-Timestamp: 1758268800" \ -H "X-Dz-Sign: 7b1e0c4d9a2f5e83c6b04a71d9e3f210" \ -H "Content-Type: application/json"

正常返回:

{ "code": 0, "message": "success", "data": { "total": 1284, "page": 1, "page_size": 100, "list": [ { "record_id": "ORD20260918000731", "module": "order", "status": "completed", "amount": 4860.00, "dept_id": "D1042", "created_at": "2026-09-18 14:07:31" } ] } }

写入单据时带上 idempotency_key,同一个键 24 小时内重复提交只会生效一次,网络重试不会产生重复数据。

返回码说明

codeHTTP 状态含义与处理建议
0200成功
40001400参数缺失或格式错误,响应 message 里会指明字段名
40101401签名校验失败,检查 AppSecret 与签名算法
40102401时间戳超出 5 分钟窗口,校准服务器时间
40301403当前套餐未开放该接口,需升级到专业版及以上
42901429触发频率限制,按响应头 Retry-After 退避重试
50001500服务端异常,可携带 request_id 联系技术支持

服务等级与数据备份

不同套餐的保障标准如下,未达到承诺可用率的按当月订阅费 10%-30% 折算服务时长补偿。

备份与恢复

  • 数据存放于阿里云杭州可用区,三副本存储
  • 每日凌晨 02:00 全量备份,专业版起额外做增量备份
  • 客户可自助从控制台发起最近 7 天内任意时点的数据恢复申请
  • 企业版可申请每季度一次的恢复演练,我们出具演练报告

数据归属

客户数据的所有权归客户。订阅到期后数据保留 90 天,期间可随时导出为 Excel 或 JSON;超过 90 天未续费的按隐私政策清除,清除前 7 天发邮件提醒。

常见问题