DEVELOPER / API
API 文档
面向数据导出服务的公开接口说明。此页面不会显示任何真实令牌。
鉴权
API 与控制台使用相互独立的凭据。
Authorization: Bearer <API_TOKEN>
API 令牌与控制台令牌都来自桌面 config.json 的 service_access_token(api_access_token / web_access_token),两者独立。
公共接口
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /health | 健康检查 |
| POST | /webhooks/smsforwarder | 短信回调,无 Bearer |
导出接口
所有 /api/v1/ 路由都要求 Bearer 令牌。
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/sources | 数据源、配置状态与可用性元数据 |
| POST | /api/v1/jobs | 创建 SAP、CIS、财务中台或 LMS 任务 |
| GET | /api/v1/jobs | 查询最近任务 |
| GET | /api/v1/jobs/{id} | 查询单任务状态 |
| GET | /api/v1/jobs/{id}/download | 下载已完成的文件 |
创建任务
{"source":"sap","parameters":{"orgs":["6816","1217"],"from_date":"2026-01-01","to_date":"2026-01-01"}}sap_6800 使用 from_date、to_date,服务端固定销售组织 6800 及客户 2002682、2110450;不能把 6800 混入普通 sap 任务。cis、普通分销网络明细和截图源使用 from_date、to_date;source 名称由 /api/v1/sources 返回。
财务中台库龄分析使用 {"source":"fi_inventory_age","parameters":{"company_code":"6800","org_code":"6816","owner_type":"客户"}};company_code、org_code、owner_type 三个参数都必填,不再由服务端固定,使用者类型仍不设条件。任一值在对应下拉框中不存在时,任务会直接失败,不会回退到固定值。结果是单个 XLSX。
财务中台即时库存使用 {"source":"fi_inventory","parameters":{}};参数 org_code、owner_type 可修改,也可省略,默认分别为 6816、核算组织。不使用公司代码或日期参数,导出单个 XLSX。
财务中台参数是有限页面选项:owner_type 仅 核算组织、供应商、客户;fi_inventory_age 的 company_code 当前为 1180、2600、6700、6800;org_code 必须由组织查找返回并选中,不是任意四位数。值不存在时任务直接失败,不回退默认值。即时库存不传 company_code 或日期。
LMS 发货/到货明细使用 lms_shipment_detail、lms_arrival_detail,只接受 from_date(YYYY-MM-DD),服务端按“订单时间 大于等于”查询、全量加载后直接导出当前查询结果,不勾选全选,生成单个 XLS。
截图源输出单个 PNG;普通分销网络明细输出单个 XLSX。服务器会检查对应产物结构。
控制台会话
首次访问控制台时使用前端令牌登录:/console/exports?token=...。登录后使用 HttpOnly Cookie,不发送 Bearer。