API 文档

将工厂数据接入全球工业数字网络

CNFX API 允许制造企业、系统开发者和工业软件平台以标准化方式访问和同步工业产品的结构化数据。通过 API,企业可以将自己的产品技术信息转化为机器可读取的数据资产,并与 CNFX 工业目录进行实时同步。

这使工业产品不再只是网页内容,而成为可被软件系统调用的数据节点。

为什么需要工业 API

传统信息孤岛

技术信息通常分散在 PDF 文档、产品手册、邮件附件、ERP 内部系统中,难以被自动化系统理解和使用。

CNFX API 的价值

提供标准化数据接口,让工业产品信息可以被 AI 系统读取、工程软件调用、采购系统整合、数字供应链使用,使技术数据真正进入数字化生态。

API 可以做什么

通过 CNFX API,企业或开发者可以实现以下功能:

产品数据同步
将产品型号、技术参数、应用场景等信息同步到 CNFX 工业目录。
技术规格查询
通过 API 查询标准化的产品技术结构与工程信息。
URN 标识管理
为每个产品型号生成唯一的工业资源标识(URN)。
技术文档访问
访问结构化技术文档,包括 Markdown 格式的工程说明。
AI 数据接口
为 AI 系统提供可引用的技术知识来源。

API 数据结构

CNFX API 使用统一的数据结构描述工业产品。典型数据对象包括:

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

这些数据通过统一结构进行组织,以便不同系统之间能够稳定交换。

API 访问方式

CNFX API 基于标准 Web 协议构建,支持常见的开发环境。

基本访问方式
  • 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": "5–200 Nm", "operating_voltage": "24–48 V", "control_interface": "CAN / EtherCAT" }, "applications": [ "Robotics", "Automated Assembly", "Packaging Machinery" ] }

典型应用场景

工厂官网技术数据同步
企业可以将官网产品型号数据与 CNFX 工业目录自动同步,避免重复维护。
工业软件集成
CAD/CAE 系统、工程选型工具、设备配置软件可以通过 API 调用标准产品参数。
供应链系统对接
采购系统或供应链平台可以通过 API 获取标准化产品数据,提高选型效率。
AI 知识库输入
AI 系统可以通过 API 访问工业技术数据,作为可信知识来源。

接入流程

接入 CNFX API 通常只需几个步骤:

1
创建 CNFX 企业账户
如果您还没有企业档案,请先创建。
2
申请 API Key
在企业后台申请 API 密钥。
3
配置数据同步或调用接口
根据文档集成 API。
4
测试接口并上线
在测试环境验证后正式启用。

CNFX 团队可以为企业提供基本的接入指导。

API 使用权限

API 权限取决于企业订阅方案。不同方案可能包括:API 调用次数限制、可同步产品数量、数据更新频率。详细权限请参考定价页面

数据安全

CNFX API 采用标准安全机制保护数据:HTTPS 加密传输、API Key 身份验证、访问频率限制。企业可以随时管理自己的 API Key。

技术支持

如果您计划将系统接入 CNFX API,可以联系我们的技术团队。我们可以提供:API 接入说明、数据结构示例、基础技术支持。

联系技术支持

开始接入

如果您希望将产品技术数据接入 CNFX 工业目录,可以申请 API 访问权限。创建企业档案并申请 API Key,即可开始集成。

创建企业档案 申请 API Key