跳到主要内容

开放接口清单

口径

已开放(启用)接口快照: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 数组)。 请求结构、容量上限与重试规则见批量操作。

实体后端签名(路径前缀)接口数完整清单
销售数据任务 sales.data-task-center/v1/data-task-center读 1 / 写 1接口参考
供应链数据任务 srm.data-task-center/v1/data-task-center读 1 / 写 1接口参考
财务数据任务 finance.data-task-center/v1/data-task-center读 1 / 写 1接口参考
项目数据任务 project.data-task-center/v1/data-task-center读 1 / 写 1接口参考

每组含 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. + 模块 + . + 配置项标识 + 动作。

模块配置项接口数完整清单
销售 config.sales31 项读 33 / 写 111接口参考
采购与供应链 config.srm35 项读 45 / 写 124接口参考
项目 config.project14 项读 24 / 写 62接口参考
财务 config.finance2 项(付款方式、发票邮箱)读 3 / 写 8接口参考

销售的 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 个标记高危。

实体后端签名(路径前缀)接口数完整清单
检验单 quality.inspection-sheet/v1/inspection-sheets读 5 / 写 6接口参考
不合格处理 quality.ncr/v1/ncr读 3 / 写 8接口参考
产品实例追溯 quality.barcode-center/v1/barcode-center读 5 / 写 0接口参考
待检库存 quality.stock-pending/v1/stock-pending读 3 / 写 2接口参考
SN 核验 quality.sn/v1/sn读 3 / 写 0接口参考

财务域(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.expense/v1/expense读 8 / 写 16接口参考
费用类别 finance.expense-categories/v1/expense-categories读 1 / 写 4接口参考
借款单 finance.loans/v1/loans读 4 / 写 11接口参考
银行借款 finance.bank-loans/v1/bank-loans读 5 / 写 7接口参考

旧的「财务分类」接口(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.cost-order/v1/cost-order读 2 / 写 4接口参考
成本池 finance.cost-pool/v1/cost-pool读 5 / 写 5接口参考
成本结转 finance.cost-transfer/v1/cost-transfer读 4 / 写 6接口参考
收入确认 finance.revenue-recognition/v1/revenue-recognition读 4 / 写 9接口参考

期初、报表与其他​

实体后端签名(路径前缀)接口数完整清单
期初数据 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 个接口,全部为读。

实体后端签名(路径前缀)接口数后端服务完整清单
角色 system.role/v1/role5comap-system接口参考
部门 system.department/v1/department4comap-system接口参考
用户 system.user/v1/user4comap-system接口参考
字段定义 system.field/v1/field1comap-field接口参考

用户、部门、角色的写操作(创建/删除用户、分配角色权限、离职流程、部门排序等) 属账号与权限治理,风险较高,未纳入开放范围。

人事与办公域(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 行导入,见上文「批量导入与批量删除」)。