开放接口清单
已开放(启用)接口快照:2424 条(2026-09-30)。权威实时清单以 MCP 元工具
search_apis / 管理员控制台为准,本页随批次更新。
一分钟看懂怎么调
所有接口不按后端路径直接调用,统一走直通入口,用 apiCode 指定接口:
# 查询类(query 参数型):查销售订单第一页
# 本示例使用 AppKey;也可用 Authorization: Bearer <token> 替代这两个鉴权头
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "X-App-Key: oak_xxx" \
-H "X-App-Secret: oas_xxx" \
-H "Content-Type: application/json" \
-d '{ "apiCode": "sales.order.page", "query": { "pageNum": 1, "pageSize": 10 } }'
# 写操作(body 型):创建线索
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "X-App-Key: oak_xxx" -H "X-App-Secret: oas_xxx" \
-H "Content-Type: application/json" \
-d '{ "apiCode": "sales.lead.create", "body": { "leadName": "…", "phone": "…" } }'
以上为 Bash / 类 Unix shell 示例,需替换域名、凭证及业务字段。创建线索仅演示请求结构,不能直接作为完整入参;请先查看对应接口参考。
JSON 业务响应使用统一信封,data 即下游业务数据;文件接口成功时直接返回文件,
失败时返回错误信封。入口鉴权失败不套此格式,须先检查 HTTP 状态,见错误码:
{ "code": 200, "message": "success", "data": { "records": [ … ], "total": 137 } }
失败时 code 非 200:92202 凭证范围不足、92204 员工无该模块功能权限、
92201 接口未开放,完整见错误码。
字段级参数从哪里查
| 途径 | 适用 |
|---|---|
| 接口参考(本站) | 每个接口的请求/响应字段表,按域 × 实体组织,由后端规格快照自动生成——首选 |
MCP 元工具 describe_api | 返回参数说明、所需范围、是否高危——agent 与人都可用 |
| 后端 Swagger(内部开发者) | 下表"后端签名"列出目标服务与路径;到对应服务的 springdoc(/v3/api-docs / swagger-ui)按路径查 Controller,请求 DTO 的字段即 query/body 结构 |
分页查询分两种:GET 型参数放
query(pageNum/pageSize+ 筛选字段); POST 型(标注"POST体")筛选条件整体放body(含pageNum/pageSize)。 标 † 的为高危接口:MCP 调用须先向用户复述并获同意后携confirm: true。
批量导入与批量删除
批量新建走各服务的 JSON 行导入(异步任务,轮询取结果),批量删除走实体的 .batch-delete(body 为 id 数组)。
请求结构、容量上限与重试规则见批量操作。
每组含 import-rows(提交,高危,仅系统管理员)与 import-result(查询结果)。
销售域(sales)
所需范围:查询 sales:read,写 sales:write。后端服务 comap-sales。
单据与主数据
apiCode 规则:前缀.动作,如 sales.order.page、sales.customer.create。
.batch-delete 单次上限 200 条(销售订单、发货单 50 条),逐条处理并返回成功 / 失败明细。
| 实体 | 后端签名(路径前缀) | 查询 | 详情 | 新增 | 更新 | 删除† | 状态操作† |
|---|---|---|---|---|---|---|---|
客户 sales.customer | /v1/customer | .page(POST体) | .detail | .create | .update | .delete、.batch-delete | — |
客户联系人 sales.customer.contact | /v1/customer/contact | .page(POST体)、.list | — | .create | .update | .delete、sales.contact.batch-delete | — |
线索 sales.lead | /v1/lead | .page | .detail | .create | .update | .delete、.batch-delete | .convert 转化 |
商机 sales.opportunity | /v1/opportunity | .page、.list-by-customer | .detail | .create | .update | .delete、.batch-delete | — |
报价 sales.quotation | /v1/quotation | .page | .detail | .create | .update | .delete、.batch-delete | .submit 提交审核、.withdraw 撤回、.cancel 作废 |
销售订单 sales.order | /v1/sales-order | .page | .detail | .create | .update | .delete、.batch-delete | .submit 提交审批、.withdraw 撤回、.submit-acceptance 提交验收、.cancel-no-invoice 重新开启开票 |
销售合同 sales.contract | /v1/sales-contract | .page | .detail | .create | .update | .delete、.batch-delete | .submit、.withdraw、.complete 完成、.cancel 作废 |
发货单 sales.shipment | /v1/sales-shipment | .page(POST体) | .detail | .create | .update(待发货) | .delete(未关联出库)、.batch-delete | .confirm 已废弃(不推进状态) |
退货单 sales.return | /v1/sales-return | .page(POST体) | .detail | .create | .update(草稿) | .delete、.batch-delete | .submit 提交审批、.cancel 取消 |
2026-09-29 新增开放
以下业务随本批开放,apiCode 前缀即表中编码。写接口的必填字段见各接口页的「必填字段」一节。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
跟进记录 sales.follow-up | /v1/follow-up | 读 7 / 写 5 | 接口参考 |
拜访计划 sales.visit-plan | /v1/visit-plan | 读 3 / 写 3 | 接口参考 |
公海客户 sales.public-sea | /v1/public-sea | 读 2 / 写 7 | 接口参考 |
客户收货地址 sales.customer-shipping-address | /v1/customer/shipping-address | 读 2 / 写 4 | 接口参考 |
客户授信 sales.credit | /v1/customer/credit | 读 8 / 写 3 | 接口参考 |
客户物料对照 sales.customer-material-mapping | /v1/customer-material-mapping | 读 3 / 写 5 | 接口参考 |
客户价格表 sales.customer-price-list | /v1/customer-price-list | 读 8 / 写 5 | 接口参考 |
框架协议 sales.framework-agreement | /v1/sales/framework-agreement | 读 8 / 写 6 | 接口参考 |
价格组 sales.price-group | /v1/sales/price-group | 读 4 / 写 5 | 接口参考 |
价格调整 sales.price-adjustment | /v1/sales/price-adjustment | 读 3 / 写 4 | 接口参考 |
物料售价查询 sales.price-product | /v1/sales/price-product | 读 5 / 写 2 | 接口参考 |
特价申请 sales.special-price-application | /v1/special-price-application | 读 4 / 写 4 | 接口参考 |
投标项目 sales.bid-project | /v1/bid-project | 读 3 / 写 8 | 接口参考 |
投标任务 sales.bid-task | /v1/bid-task | 读 1 / 写 4 | 接口参考 |
商务函件 sales.business-letter | /v1/business-letter | 读 2 / 写 4 | 接口参考 |
商誉订单 sales.goodwill | /v1/goodwill | 读 3 / 写 6 | 接口参考 |
附加费用 sales.additional-fee | /v1/additional-fees | 读 7 / 写 8 | 接口参考 |
其他收入 sales.other-income | /v1/other-income | 读 2 / 写 4 | 接口参考 |
销售收款流水 sales.collection-flow | /v1/sales-collection | 读 6 / 写 3 | 接口参考 |
销售目标 sales.sales-target | /v1/sales-target | 读 2 / 写 3 | 接口参考 |
销售团队 sales.team | /v1/sales-team | 读 3 / 写 0 | 接口参考 |
销售业绩 sales.performance | /v1/sales-performance | 读 7 / 写 0 | 接口参考 |
销售报表 sales.report | /v1/sales-report | 读 8 / 写 0 | 接口参考 |
2026-09-30 新增开放:售后服务
售后服务模块(服务工单、报价、配件申请、工时与费用、结算、质保卡与质保规则、维修)共 120 个接口,
编码前缀为 sales.service-*,后端路径集中在 /v1/service-orders 与 /v1/repairs。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
服务工单 sales.service-order | /v1/service-orders | 读 17 / 写 30 | 接口参考 |
服务工作台 sales.service-workspace | /v1/service-orders/workspace | 读 10 / 写 0 | 接口参考 |
服务报价 sales.service-quotation | /v1/service-orders/quotation | 读 3 / 写 8 | 接口参考 |
配件申请 sales.service-part-request | /v1/service-orders/part-request | 读 3 / 写 8 | 接口参考 |
服务工时 sales.service-labor | /v1/service-orders/labor | 读 1 / 写 2 | 接口参考 |
服务费用 sales.service-cost | /v1/service-orders/cost | 读 1 / 写 3 | 接口参考 |
服务结算 sales.service-settlement | /v1/service-orders/settlement | 读 3 / 写 4 | 接口参考 |
质保卡 sales.service-warranty-card | /v1/service-orders/warranty-card | 读 3 / 写 7 | 接口参考 |
质保规则 sales.service-warranty-rule | /v1/service-orders/warranty-rule | 读 3 / 写 3 | 接口参考 |
客户资产 sales.service-customer-asset | /v1/service-orders/customer-asset | 读 3 / 写 0 | 接口参考 |
维修单 sales.service-repair | /v1/repairs | 读 3 / 写 5 | 接口参考 |
业务设置域(config)
所需范围:查询 config:read,写 config:write。与所属业务域的范围相互独立——
勾了 sales:read 并不能读销售的业务设置,需另行勾选 config:read。
业务设置横跨多个业务模块,故独立成域。apiCode = config. + 模块 + . + 配置项标识 + 动作。
销售的 24 项基础字典每项均有 4 个接口:查询用裸编码(不带动作后缀),写操作为
.create / .update / .delete† —— 如查询 config.sales.lead-source、
新增 config.sales.lead-source.create。
2026-09-29 新增的 7 项(客户分类、客户级别、联系人决策权重、客户标签、跟进结果、
线索意向等级、商机输单原因)另有 .sort 排序、标签分类维护等动作,逐条见接口参考。
其余四个模块的动作段按后端接口命名,不遵循这套四件套:
查询多为 .list / .tree / .page / .detail,写操作除
.create / .update / .delete 外还有 .save(新增或更新合一)、
.toggle / .toggle-enabled(启停)、.sort(排序)、.set-default(设默认)等,
逐条见接口参考。
config.project 的 14 项覆盖项目类型、任务类型、工时类型、成本与费用配置、
项目角色、日志标签与分类、计划模板等。
config.srm 的 35 项覆盖物料(分类、计量单位、品牌、来源类型、物料属性、编码规则、
单位换算、条码模板)、BOM 分类、供应商(级别、分类)、采购(分类、付款条件、应付节点模板)、
仓储(仓库类型、报损类型、锁库/释放原因、其他出入库类型、物流公司)、
质检(检验方案、检验项目及其分类)、生产(改制/拆解原因)、委外(加工类型、退料原因、
加工价目、全局配置)、商品图片命名规则与导入导出模板。
2026-08-30 起销售业务设置编码由
sales.config.*迁至config.sales.*,所需范围 由sales:*改为config:*。旧编码已失效,调用会返回92201。2026-08-31 起 BOM 分类由
srm.bom.category.*迁至config.srm.bom-category.*, 范围由srm:*改为config:*,同样是破坏性变更。
| 配置项 | 标识 | 后端签名 |
|---|---|---|
| 线索来源 | lead-source | /v1/lead-source |
| 线索状态 | lead-status | /v1/lead-status |
| 商机来源 | opportunity-source | /v1/opportunity-source |
| 商机阶段 | opportunity-stage | /v1/opportunity-stage |
| 报价条款 | quotation-term | /v1/quotation-term |
| 报价类型 | quotation-type | /v1/quotation-type |
| 付款条件 | payment-terms | /v1/sales-payment-terms |
| 合同类型 | contract-type | /v1/sales-contract-type |
| 合同条款模板 | contract-terms-template | /v1/sales-contract-terms-template |
| 跟进类型 | follow-up-type | /v1/follow-up-type |
| 拜访目的 | visit-purpose | /v1/visit-purpose |
| 行业配置 | industry | /v1/industry-config |
| 退货原因 | return-reason | /v1/sales-return-reason |
| 验收方式 | acceptance-method | /v1/sales-acceptance-method |
| 验收节点模板 | acceptance-node-template | /v1/sales-acceptance-node-template |
| Goodwill 分类 | goodwill-category | /v1/goodwill-category |
| 服务成本类型 | service-cost-type | /v1/service-cost-type |
| 招投标方式 | bidding-method | /v1/bidding-method |
| 招投标标签 | bidding-tag | /v1/bidding-tag |
| 招投标模板分类 | bidding-template-category | /v1/bidding-template-category |
| 公司抬头 | company-header | /v1/company-header |
| 协作责任 | collaboration-responsibility | /v1/collaboration-responsibility |
| 业绩分配原因 | performance-allocation-reason | /v1/performance-allocation-reason |
| 红绿灯规则 | traffic-light-rule | /v1/traffic-light-rule |
采购与供应链域(srm)
所需范围:查询 srm:read,写 srm:write。后端服务 comap-srm。
采购与供应链的业务设置(物料分类、计量单位、供应商级别、采购付款条件等 35 项) 不在本域,见业务设置域;委外、生产、质检、库存各自独立成域。
共 303 个接口(读 137 / 写 166),其中 100 个标记高危。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
供应商 srm.supplier | /v1/supplier | 读 24 / 写 40 | 接口参考 |
物料 srm.product | /v1/product | 读 20 / 写 26 | 接口参考 |
采购订单 srm.purchase | /v1/purchase | 读 18 / 写 24 | 接口参考 |
BOM srm.bom | /v1/bom | 读 12 / 写 18 | 接口参考 |
采购退货 srm.purchase-retreat | /v1/purchase-retreat | 读 9 / 写 12 | 接口参考 |
采购询价 srm.purchase-ask | /v1/purchase-ask | 读 8 / 写 10 | 接口参考 |
到货单 srm.arrival | /v1/arrival | 读 10 / 写 7 | 接口参考 |
采购申请 srm.purchase-apply | /v1/purchase-apply | 读 5 / 写 11 | 接口参考 |
采购付款申请 srm.purchase-payment | /v1/purchase-payment | 读 7 / 写 5 | 接口参考 |
采购待办池 srm.pending-pool | /v1/pending-pool | 读 6 / 写 4 | 接口参考 |
到货通知 srm.arrival-notice | /v1/arrival-notice | 读 3 / 写 5 | 接口参考 |
综合物料搜索 srm.material | /v1/material | 读 4 / 写 0 | 接口参考 |
采购报表 srm.purchase-report | /v1/purchase-report | 读 4 / 写 0 | 接口参考 |
单据物料导入 srm.material-import | /v1/material-import | 读 1 / 写 1 | 接口参考 |
公司信息搜索 srm.company | /v1/company | 读 1 / 写 0 | 接口参考 |
快递物流查询 srm.express | /v1/express | 读 1 / 写 0 | 接口参考 |
单据完结 srm.document-completion | /v1/document-completion | 读 3 / 写 2 | 接口参考 |
库存域(inventory)
所需范围:查询 inventory:read,写 inventory:write。后端服务 comap-srm。
库存虽在采购与供应链服务内,但权限上独立成域——可只授予库存而不给采购。
共 158 个接口(读 86 / 写 72),其中 44 个标记高危。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
库存 inventory.stock | /v1/stock | 读 34 / 写 2 | 接口参考 |
出库单 inventory.outbound | /v1/outbound-order | 读 9 / 写 13 | 接口参考 |
入库单 inventory.inbound | /v1/inbound-order | 读 10 / 写 11 | 接口参考 |
盘点单 inventory.check | /v1/stock-check | 读 4 / 写 14 | 接口参考 |
库位 inventory.location | /v1/store-location | 读 6 / 写 9 | 接口参考 |
调拨单 inventory.transfer | /v1/stock-transfer | 读 4 / 写 9 | 接口参考 |
报废与损溢 inventory.damage | /v1/stock-damage | 读 4 / 写 8 | 接口参考 |
仓库 inventory.store | /v1/store | 读 6 / 写 5 | 接口参考 |
库存预警 inventory.warning | /v1/stock-warning | 读 5 / 写 1 | 接口参考 |
库存报表 inventory.report | /v1/inventory-report | 读 4 / 写 0 | 接口参考 |
委外域(subcontract)
所需范围:查询 subcontract:read,写 subcontract:write。后端服务 comap-srm。
委外加工全链路:订单、发料、回厂、退料、对账,以及供应商档案、报表与追溯。
委外承载于采购与供应链服务,但权限上独立成域——可只授予委外协作而不给采购下单权。
共 98 个接口(读 49 / 写 49),其中 45 个标记高危。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
委外发料单 subcontract.issues | /v1/subcontract/issues | 读 8 / 写 9 | 接口参考 |
委外对账单 subcontract.reconciliations | /v1/subcontract/reconciliations | 读 5 / 写 11 | 接口参考 |
委外订单 subcontract.orders | /v1/subcontract/orders | 读 4 / 写 10 | 接口参考 |
委外回厂单 subcontract.receives | /v1/subcontract/receives | 读 5 / 写 8 | 接口参考 |
委外报表 subcontract.reports | /v1/subcontract/reports | 读 13 / 写 0 | 接口参考 |
委外退料单 subcontract.returns | /v1/subcontract/returns | 读 4 / 写 8 | 接口参考 |
委外供应商档案 subcontract.suppliers | /v1/subcontract/suppliers | 读 2 / 写 3 | 接口参考 |
委外追溯链 subcontract.traces | /v1/subcontract/traces | 读 3 / 写 0 | 接口参考 |
委外待入库 subcontract.pending-inbounds | /v1/subcontract/pending-inbounds | 读 2 / 写 0 | 接口参考 |
委外操作轨迹 subcontract.timeline | /v1/subcontract/timeline | 读 2 / 写 0 | 接口参考 |
委外表单元数据 subcontract.form-metadata | /v1/subcontract/form-metadata | 读 1 / 写 0 | 接口参考 |
生产域(production)
所需范围:查询 production:read,写 production:write。后端服务 comap-srm。
装配、拆解、生产领料与改制四类单据,另有商品组合定义、组装报表与缺料看板。
改制原因、拆解原因属业务设置,见业务设置域。
共 54 个接口(读 28 / 写 26),其中 19 个标记高危。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
装配单 production.assembly | /v1/production/assembly | 读 4 / 写 9 | 接口参考 |
商品组合 production.bundle | /v1/product-bundle | 读 4 / 写 6 | 接口参考 |
拆解单 production.disassembly | /v1/production/disassembly | 读 4 / 写 4 | 接口参考 |
组装报表 production.assembly-report | /v1/assembly-report | 读 7 / 写 0 | 接口参考 |
改制单 production.rework | /v1/production/rework | 读 3 / 写 4 | 接口参考 |
生产领料单 production.requisition | /v1/production/requisition | 读 3 / 写 3 | 接口参考 |
生产通用 production.common | /v1/production/options | 读 2 / 写 0 | 接口参考 |
缺料看板 production.shortage | /v1/production/shortage | 读 1 / 写 0 | 接口参考 |
质检域(quality)
所需范围:查询 quality:read,写 quality:write。后端服务 comap-srm。
来料检验单、不合格处理(NCR)、待检库存,以及产品实例追溯与 SN 核验。
检验方案、检验项目及其分类属业务设置,见业务设置域。
共 35 个接口(读 19 / 写 16),其中 14 个标记高危。
财务域(finance)
所需范围:查询 finance:read,写 finance:write。后端服务 comap-finance。
共 382 个接口(读 151 / 写 231),其中 190 个标记高危——财务写操作绝大多数
涉及资金、审批状态或账务数据,MCP 调用须携 confirm: true。
各实体的路径前缀即 apiCode 第二段,如 finance.ar.page 对应 POST /v1/ar/page。
应收与收款
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
应收账款 finance.ar | /v1/ar | 读 8 / 写 13 | 接口参考 |
收款单 finance.collection | /v1/collection | 读 4 / 写 7 | 接口参考 |
预收款 finance.advance-receipt | /v1/advance-receipt | 读 4 / 写 4 | 接口参考 |
退款单 finance.refund | /v1/refund | 读 4 / 写 13 | 接口参考 |
对账单 finance.reconciliations | /v1/reconciliations | 读 4 / 写 8 | 接口参考 |
核销 finance.writeoff | /v1/writeoff | 读 2 / 写 3 | 接口参考 |
应付与付款
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
应付账款 finance.ap | /v1/ap | 读 11 / 写 9 | 接口参考 |
付款单 finance.payment | /v1/payment | 读 4 / 写 12 | 接口参考 |
付款申请 finance.payment-request | /v1/payment-request | 读 4 / 写 10 | 接口参考 |
预付款 finance.advance-payment | /v1/advance-payment | 读 3 / 写 4 | 接口参考 |
应收应付对冲 finance.ar-ap-offset | /v1/ar-ap-offset | 读 4 / 写 6 | 接口参考 |
预收付核销 finance.advance-offset | /v1/advance-offset | 读 2 / 写 2 | 接口参考 |
预收付转移 finance.advance-transfer | /v1/advance-transfer | 读 3 / 写 1 | 接口参考 |
发票
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
发票 finance.invoices | /v1/invoices | 读 7 / 写 12 | 接口参考 |
开票申请 finance.invoice-applies | /v1/invoice-applies | 读 5 / 写 6 | 接口参考 |
发票邮箱 finance.invoice-mailbox | /v1/invoice-mailbox | 读 4 / 写 2 | 接口参考 |
发票税额调整 finance.invoice-tax-adjustments | /v1/invoice-tax-adjustments | 读 3 / 写 0 | 接口参考 |
未开票查询 finance.invoice-uninvoiced | /v1/invoice-uninvoiced | 读 1 / 写 0 | 接口参考 |
费用与借款
旧的「财务分类」接口(finance.fin-categories.*,/v1/fin-categories)已停用,请改用费用类别 finance.expense-categories.*。
资金与银行
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
资金流水 finance.fund-flow | /v1/fund-flow | 读 5 / 写 4 | 接口参考 |
银行账户 finance.bank-accounts | /v1/bank-accounts | 读 5 / 写 6 | 接口参考 |
银行流水 finance.bank-transactions | /v1/bank-transactions | 读 4 / 写 6 | 接口参考 |
银行流水导入模板 finance.bank-import-templates | /v1/bank-import-templates | 读 1 / 写 2 | 接口参考 |
收款账户 finance.receiving-accounts | /v1/receiving-accounts | 读 1 / 写 4 | 接口参考 |
币种 finance.currencies | /v1/currencies | 读 2 / 写 4 | 接口参考 |
汇率 finance.exchange-rates | /v1/exchange-rates | 读 2 / 写 0 | 接口参考 |
成本与收入
期初、报表与其他
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
期初数据 finance.opening | /v1/opening | 读 3 / 写 12 | 接口参考 |
财务报表 finance.report | /v1/report | 读 1 / 写 6 | 接口参考 |
报表订阅 finance.report-schedule | /v1/report-schedule | 读 1 / 写 5 | 接口参考 |
订单优惠申请 finance.order-discounts | /v1/order-discounts | 读 5 / 写 7 | 接口参考 |
合并付款 finance.payment-merged | /v1/payment-merged | 读 6 / 写 0 | 接口参考 |
待确认存货成本 finance.inventory-cost | /v1/inventory-cost | 读 3 / 写 0 | 接口参考 |
发票税率差异留痕 finance.invoice-tax-variances | /v1/invoice-tax-variances | 读 1 / 写 0 | 接口参考 |
项目域(project)
所需范围:查询 project:read,写 project:write。后端服务 comap-project。
项目计划、任务与子任务、里程碑、工时与闲置工时、费用与成本、支出合同、日报与项目日志、项目分析报表,以及图纸全生命周期(档案、版本、评审、发布、变更、发放、权限、目录、客户图纸)与交付包。
项目类型、任务类型、工时类型、成本配置等 14 项属业务设置,见业务设置域。
交付包的免登录分享链接(受邀方凭密码或短信验证码访问)不在开放范围内。
共 281 个接口(读 114 / 写 167),其中 119 个标记高危。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
图纸 project.drawing | /v1/drawing | 读 38 / 写 69 | 接口参考 |
项目计划 project.project-plan | /v1/project-plan | 读 9 / 写 9 | 接口参考 |
工时 project.timesheets | /v1/timesheets | 读 7 / 写 8 | 接口参考 |
项目 project.projects | /v1/projects | 读 4 / 写 10 | 接口参考 |
交付包分享 project.delivery-shares | /v1/delivery-shares | 读 5 / 写 8 | 接口参考 |
交付节点 project.delivery-nodes | /v1/delivery-nodes | 读 2 / 写 8 | 接口参考 |
交付包 project.delivery-packages | /v1/delivery-packages | 读 3 / 写 7 | 接口参考 |
项目分析 project.project-analytics | /v1/project-analytics | 读 8 / 写 0 | 接口参考 |
任务 project.tasks | /v1/tasks | 读 3 / 写 5 | 接口参考 |
支出合同 project.project-contracts | /v1/project-contracts | 读 2 / 写 5 | 接口参考 |
项目费用 project.project-expenses | /v1/project-expenses | 读 2 / 写 5 | 接口参考 |
项目日志 project.project-log | /v1/project-log | 读 3 / 写 4 | 接口参考 |
关联销售合同 project.project-sales-contracts | /v1/project-sales-contracts | 读 5 / 写 2 | 接口参考 |
关联销售订单 project.project-sales-orders | /v1/project-sales-orders | 读 4 / 写 2 | 接口参考 |
日报 project.daily-reports | /v1/daily-reports | 读 2 / 写 3 | 接口参考 |
闲置工时 project.idle-times | /v1/idle-times | 读 2 / 写 3 | 接口参考 |
里程碑 project.project-milestones | /v1/project-milestones | 读 1 / 写 4 | 接口参考 |
子任务 project.task-subtasks | /v1/task-subtasks | 读 1 / 写 4 | 接口参考 |
项目成员 project.project-members | /v1/project-members | 读 1 / 写 3 | 接口参考 |
项目日志回复 project.project-log-reply | /v1/project-log-reply | 读 1 / 写 2 | 接口参考 |
项目报表 project.project-report | /v1/project-report | 读 3 / 写 0 | 接口参考 |
任务评论 project.task-comments | /v1/task-comments | 读 1 / 写 2 | 接口参考 |
承诺订单 project.project-commitment-orders | /v1/project-commitment-orders | 读 1 / 写 0 | 接口参考 |
项目成本费用 project.project-cost-expenses | /v1/project-cost-expenses | 读 1 / 写 0 | 接口参考 |
项目成本 project.project-costs | /v1/project-costs | 读 1 / 写 0 | 接口参考 |
审批表单 schema project.workflow-form | /v1/workflow-form | 读 0 / 写 1 | 接口参考 |
单据完结 project.document-completion | /v1/document-completion | 读 3 / 写 2 | 接口参考 |
审批流域(workflow)
所需范围:workflow:read / workflow:write(已有授权需重新授权才能勾选此域)。
后端服务 comap-workflow。
| apiCode | 名称 | 后端签名 | 类型 |
|---|---|---|---|
workflow.task.todo | 我的待办任务分页 | GET /v1/workflow/task/todo | 读 |
workflow.task.done | 我的已办任务分页 | GET /v1/workflow/task/done | 读 |
workflow.task.cc | 抄送我的任务分页 | GET /v1/workflow/task/cc | 读 |
workflow.task.detail | 审批任务详情 | GET /v1/workflow/task/detail?id= | 读 |
workflow.task.stats | 待办任务统计 | GET /v1/workflow/task/stats | 读 |
workflow.instance.my | 我发起的流程分页 | GET /v1/workflow/instance/my | 读 |
workflow.instance.detail | 流程实例详情 | GET /v1/workflow/instance/detail?id= | 读 |
workflow.history.instance | 流程实例审批历史 | GET /v1/workflow/history/instance?instanceId= | 读 |
workflow.history.business | 业务单据历次审批历史 | GET /v1/workflow/history/business | 读 |
workflow.definition.initiable | 可发起的流程列表 | GET /v1/workflow/definition/initiable | 读 |
workflow.task.claim | 签收任务 | POST /v1/workflow/task/claim | 写 |
workflow.task.approve | 审批任务(同意/驳回) | POST /v1/workflow/task/approve | 写 † |
workflow.task.transfer | 转办任务 | POST /v1/workflow/task/transfer | 写 † |
workflow.task.urge | 催办任务 | POST /v1/workflow/task/urge | 写 |
workflow.instance.cancel | 取消我发起的流程 | POST /v1/workflow/instance/cancel | 写 † |
系统域(system)
所需范围:system:read。本域只读,不提供写操作。
组织架构与元数据的只读查询,供集成方填充人员/部门/角色选择器、 或把业务数据里的 ID 翻译成名称。字段定义接口另供高级筛选取可用字段清单。
共 14 个接口,全部为读。
用户、部门、角色的写操作(创建/删除用户、分配角色权限、离职流程、部门排序等) 属账号与权限治理,风险较高,未纳入开放范围。
人事与办公域(office)
所需范围:查询 office:read,写 office:write。后端服务 comap-office。
2026-09-29 起开放行政办公能力,共 288 个接口(读 116 / 写 172),其中 86 个标记高危, 在接口参考中归入「行政」分类。
| 实体 | 后端签名(路径前缀) | 接口数 | 完整清单 |
|---|---|---|---|
通讯录 office.contacts | /v1/contacts/list | 读 1 / 写 0 | 接口参考 |
待办 office.todo | /v1/todos | 读 6 / 写 22 | 接口参考 |
用车 office.vehicle | /v1/vehicles | 读 10 / 写 17 | 接口参考 |
设备与工单 office.equipment | /v1/equipment | 读 12 / 写 14 | 接口参考 |
设备分类 office.equipment-category | /v1/equipment-categories | 读 3 / 写 3 | 接口参考 |
物品借用 office.lending | /v1/lending | 读 5 / 写 11 | 接口参考 |
资质证书 office.certificate | /v1/certificates | 读 9 / 写 10 | 接口参考 |
办公物料 office.material | /v1/materials | 读 6 / 写 10 | 接口参考 |
礼品 office.gift | /v1/gifts | 读 8 / 写 10 | 接口参考 |
用印 office.seal | /v1/seals | 读 5 / 写 8 | 接口参考 |
材料库 office.material-library | /v1/material-library | 读 6 / 写 5 | 接口参考 |
文档 office.document | /v1/documents | 读 2 / 写 10 | 接口参考 |
规章制度 office.policy | /v1/policies | 读 4 / 写 7 | 接口参考 |
规章制度分类 office.policy-category | /v1/policy-categories | 读 2 / 写 5 | 接口参考 |
员工手册 office.handbook | /v1/handbooks | 读 3 / 写 3 | 接口参考 |
员工手册分类 office.handbook-category | /v1/handbook-categories | 读 2 / 写 5 | 接口参考 |
会议 office.meeting | /v1/meetings | 读 3 / 写 6 | 接口参考 |
会议室 office.meeting-room | /v1/meeting-rooms | 读 3 / 写 3 | 接口参考 |
政策申报 office.declaration | /v1/declarations | 读 3 / 写 5 | 接口参考 |
工作汇报 office.work-report | /v1/work-reports | 读 2 / 写 7 | 接口参考 |
固定资产 office.fixed-asset | /v1/assets | 读 2 / 写 3 | 接口参考 |
考勤记录与统计 office.attendance | /v1/attendance | 读 7 / 写 2 | 接口参考 |
出差 office.business-trip | /v1/business-trips | 读 3 / 写 1 | 接口参考 |
加班 office.overtime | /v1/overtimes | 读 3 / 写 2 | 接口参考 |
请假 office.leave | /v1/leaveQuota | 读 3 / 写 2 | 接口参考 |
假期额度 office.leave-quota | /v1/leaveQuota | 读 2 / 写 0 | 接口参考 |
酒水库存 office.beverage | /v1/beverages/stock/page | 读 1 / 写 1 | 接口参考 |
考勤补签、请假、加班、出差可查询,也可以当前用户身份提交申请;草稿只能由本人提交。 查询按授权员工的数据权限返回,请假详情的事由与附件可能含敏感信息。 审批、多数反审核、派车结算、折旧计提等管理动作不对 AI 开放。 薪资、调薪、绩效、员工档案、入离职与招聘不对外开放——其中含个人敏感信息。
未开放的能力
流程定义管理、反审核、暂停/恢复/终止流程、通用发起(instance/start,业务发起走各
实体 .submit 更安全)、批量审批/批量转办——管理员或高扇出动作,按需评估另批开放。
财务域已开放,但一次性的内部数据回填接口(/v1/internal/*)不在其列。
人事与办公(HR/OA)开放行政办公能力与考勤类申请;薪资、员工档案、绩效、入离职与招聘
均不对外开放——其中含个人敏感信息。系统域的账号与权限写操作(创建删除用户、
分配权限、离职流程)同样不开放。
交付包的免登录分享链接(/v1/public/*,受邀方凭密码或短信验证码访问)设计上不经
开放平台鉴权,同样不开放;采购与供应链服务内的附件绑定、Excel 文件上传导入与导出下载、
模板下载与服务间 Feign 调用同样不对外开放(批量新建请用 JSON 行导入,见上文「批量导入与批量删除」)。