API 文档

接口需求与字段示意(内测)

本页面用于讨论工业资料与系统对接需求,具体接口范围通过 DAIP 内测咨询商议。实际可用地址、字段和访问授权需在项目中约定。

对接准备可围绕已有型号资料与接收要求展开,说明本次需要处理的对象和用途。

为什么需要工业 API

传统信息孤岛

技术信息可能分散在文件、图纸和业务系统中,可将本次需要处理的资料与版本列成清单。

CNFX API 的价值

接口需求可按接收系统分组,说明字段、格式、更新和授权要求。

API 可以做什么

对接用途可从产品同步、字段查询或技术资料读取分别说明。

产品数据同步
说明待处理的型号、参数与应用场景,附资料来源和版本。
技术规格查询
列出希望读取的型号字段、查询条件与接收格式。
URN 标识管理
已有型号标识可随资料提供,具体标识规则在项目中约定。
技术文档访问
列出所需技术文件、版本与可使用范围,说明接收方式。
AI 数据接口
说明资料用途与授权范围,保留来源、条件和适用边界。

API 数据结构

字段讨论可围绕以下项目组织,具体字段以已提供的型号资料为依据。

产品型号
产品类别
工程定义
技术参数
应用场景
失效模式摘要
材料信息
标准与合规参考

字段值应连同单位、条件、来源与版本表达,方便接收方判断适用范围。

API 访问方式

调用协议、方法、格式与认证方式均为对接时需明确的要求,下面仅作表达示例。

基本访问方式
  • HTTP REST API
  • 请求方式:GET / POST / PUT / DELETE
  • 数据格式:JSON
  • 认证方式:API Key
示例 API 请求

以下路径仅示意请求的表达方式,实际可调用地址在项目中提供。

GET /api/v1/products/{product_id}

以下仅示意字段组织,方括号中的值需要按原始资料填写。

{ "urn": "urn:cnfx:industrial:component:rotary-servo-actuator", "name": "Rotary Servo Actuator", "category": "Industrial Motion Control", "parameters": { "torque_range": "[按来源资料填写]", "operating_voltage": "[按来源资料填写]", "control_interface": "[按来源资料填写]" }, "applications": [ "Robotics", "Automated Assembly", "Packaging Machinery" ] }

典型应用场景

工厂官网技术数据同步
官网数据对接可附现有字段与更新方式,说明需要处理的范围。
工业软件集成
软件对接可说明接收系统、字段要求和资料用途,附现有样本。
供应链系统对接
供应链系统可列出所需型号、参数与来源字段,明确资料使用范围。
AI 知识库输入
知识库需求可说明资料类型、来源和使用权限,保留具体适用条件。

接入流程

接入讨论围绕现有资料与使用需求展开,可按下列顺序说明情况。

1
说明现有企业与资料
可附现有企业档案地址,并列出本次需要处理的型号资料。
2
商议接入范围与授权
通过联系入口说明使用方、接收要求与访问授权需求。
3
约定字段与对接方式
把输入、输出、更新工作及负责人员一并写清楚。
4
按约定安排测试与交付
具体测试、交付与启用安排按项目约定处理。

测试要求、对接人和支持范围,可与交付内容一并约定。

API 使用权限

调用量、型号范围和更新工作需分别说明,具体权限与价格按项目范围商议。服务分工见费用页面。

数据安全

传输方式、访问授权与密钥管理需要在对接前说明,资料的公开与受控范围也应单独列出。

技术支持

技术咨询可附字段样本、接收要求和目前遇到的问题,便于讨论所需说明与支持范围。

联系技术支持

开始接入

已有资料和对接需求时,可通过联系入口咨询内测。实际接口、授权和实施安排以项目约定为准。

创建企业档案 咨询接入与授权