《石化行业工业互联网标识解析系统接入规范》征求意见稿及编制说明

ICS35.100

CCSL79

CPCIF

中国石油和化学工业联合会团体标准

T/CPCIF00XX—20XX

石化行业工业互联网标识解析系统

接入规范

Accessspecificationforindustrialinternetidentificationsystemin

petrochemicalindustry

(征求意见稿)

20XX-XX-XX发布20XX-XX-XX实施

中国石油和化学工业联合会发布

T/CPCIF00XX—20XX

前言

本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定

起草。

本文件由中国石油和化学工业联合会提出。

本文件由中国石油和化学工业联合会标准化工作委员会归口。

本文件起草单位：XXXXXXXXXXXXXXXX。

本文件主要起草人：XXXXXXXXXXXXXXX。

II

T/CPCIF00XX—20XX

石化行业工业互联网标识解析系统接入规范

1范围

本标准是指导企业接入标识解析二级节点（石化行业）的技术性规范。

本标准将规定面向石化行业的工业互联网标识解析二级节点的接入要求、接口规范等。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。但是注日期的引用文件，仅注日期的版本适用于本文件。

凡是不注日期的文件，其最新版本（包括所有的修改单）适用于本文件。

ITU-TM.3010电信网络管理基本原则

GB/T29262面向服务体系结构（SOA）术语

GB/T29798基于Web服务的IT资源管理规范

3缩略语

下列缩略语适用于本文件。

HTTP：超文本传输协议（HyperTextTransferProtocol）

SSL：安全套接层（SecureSocketsLayer）

JSON：对象简谱（JavaScriptObjectNotationJS）

REST：一组架构约束条件和原则（RepresentationalStateTransfer）

4接入要求

4.1接入流程

4.1.1企业前缀申请

包括企业用户注册、登录，企业用户认证，企业信息填报、企业资料上传、企业前缀申请。

企业信息填报包括企业/机构名称、企业类型、机构证件类型（统一社会信用代码及其他）、证件

号、营业执照、企业/机构行业、注册所在地、地址、联系人姓名、联系人手机、联系人邮箱、法人姓

名、法人证件类型、法人证件号码等信息。

企业资料上传包括营业执照、法人证件照片。

4.1.2企业信息管理

接入企业通过帐号密码登录后，添加业务的标识模板、标识模板属性、添加开发密钥。

4.1.3标识服务解析

1

T/CPCIF00XX—20XX

企业可通过标识查询接口查询标识详细信息。

4.1.4标识服务管理

企业通过开发密钥进行标识创建、标识修改、标识删除等操作。

4.2技术要求

1)权限验证使用JWT方式。

2)企业应使用开发密钥，通过开发密钥进行标识注册，标识更新等功能操作。

3)接口所有的请求和响应数据编码皆为UTF-8格式。

4)传输使用HTTP协议；JSON数据交换格式。

5)请求参数包括公共参数和业务参数。公共参数是所有请求必须有的参数，用户请求的开发密钥

等。

4.3管理要求

1)接入企业应提供真实、准确、完整的身份信息，用户提供的身份信息不准确、不完整的，应予

以补正，用户未补正或者提供不真实的身份信息的，将停止提供标识注册服务。

2)接入企业在企业资质审核通过并获得企业前缀后，方可进行标识相关服务。

3)接入企业对自身标识数据负责。

4)接入企业进行标识注册宜遵循《石化行业工业互联网标识解析编码规范》。

5接口规范

5.1接口组成

5.1.1概述

石化行业工业互联网标识解析系统接口应包括标识查询接口、应用注册接口、模板创建接口、模板

更新接口、模板列表查询接口、标识数据注册接口、标识数据更新接口和标识数据删除接口。

5.1.2标识查询接口

提供标识解析查询服务，用户可通过标识查询接口查询标识详细信息。

5.1.3应用注册接口

提供应用注册服务，用户可通过应用注册接口注册应用并获得应用ID，作为标识数据注册的应用

ID参数。

5.1.4模板创建接口

提供模板创建服务，用户可通过模板创建接口创建模板及模板属性相关的参数。

5.1.5模板更新接口

提供模板更新服务，用户可根据模板唯一值，通过模板更新接口更新模板，并且能够更新模板属性

2

T/CPCIF00XX—20XX

相关的参数。

5.1.6模板列表查询接口

提供模板列表查询服务，用户可通过模板列表查询接口查询模板列表清单。

5.1.7标识数据注册接口

提供标识数据注册服务，用户可通过标识数据注册接口注册标识数据。

5.1.8标识数据更新接口

提供标识数据更新服务，用户可通过标识数据更新接口更新标识数据。

5.1.9标识数据删除接口

提供标识数据删除服务，用户可通过标识数据删除接口删除标识数据。

5.2接口技术要求

1）宜采用基于RestAPI接口；

2）数据的请求和返回结果宜采用JSON格式；

3）应支持跨系统、跨平台调用。

6接口模型及参数

6.1请求模型

图1接口请求模型

6.2返回模型

3

T/CPCIF00XX—20XX

图2接口返回模型

6.3接口参数

接口的具体请求和返回参数应符合附录A要求。

4

T/CPCIF00XX—20XX

附录A

（规范性）

接口及其参数说明

A.1标识查询接口

A.1.1请求路径

6:8888/third/queryData

A.1.2请求协议

HTTP

A.1.3请求方法

GET

A.1.4请求头部

表A.1标识查询接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.1.5请求参数

A.1.5.1数据格式

Json

A.1.5.2外层数据结构

Object

表A.2标识查询接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

handle[string]是无限制标识码

示例1：

{

"handle":"88.399.1XX/10100101800000980078"

}

A.1.6返回结果

A.1.6.1数据格式

5

T/CPCIF00XX—20XX

Json

A.1.6.2外层数据结构

Object

表A.3标识查询接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

status[Int]是无限制状态码

message[String]是无限制状态码描述

data[Object]是无限制返回数据

data.prefix[String]是无限制前缀

data.handle[String]是无限制标识

data.templateVersion[String]是无限制模板版本

data.value[Array]是无限制标识属性

data.value[i].auth[String]是无限制权限码，预留字段

data.value[i].index[Int]是无限制标识属性索引

data.value[i].data[Object]是无限制标识属性内容

data.value[i].data.format[String]是无限制标识属性内容格式

data.value[i].data.value[String]是无限制标识属性内容值

data.value[i].data.type[String]是无限制标识属性类型

A.2模板创建接口

A.2.1请求路径

6:8888/third/createTemplate

A.2.2请求协议

HTTP

A.2.3请求方法

POST

A.2.4请求头部

表A.4模板创建接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.2.5请求参数

6

T/CPCIF00XX—20XX

A.2.5.1数据格式

Json

A.2.5.2外层数据结构

Object

表A.5模板创建接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

description[string]否无限制模板描述

items[array]否无限制模板包含的字段

items>>idType[string]否255字段英文名

items>>maxLength[int]否无限制字段最长长度

items>>minLength[int]否无限制字段最小长度

items>>name[string]否255字段中文名

items>>required[int]否无限制是否必填

name[string]否无限制模板名字

示例2：

{

"name":"设备信息标识模板",

"description":"企业的设备标识信息模板",

"version":"1.0",

"items":[

{

"name":"产品编号",

"idType":"Product_id",

"required":"0",

"minLength":1,

"maxLength":200

},

{

"name":"产品名称",

"idType":"Product_name",

"required":"0",

"minLength":1,

"maxLength":200

}

]

}

A.2.6返回结果

A.2.6.1数据格式

Json

A.2.6.2外层数据结构

7

T/CPCIF00XX—20XX

Object

表A.6模板创建接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

data[object]是无限制模板信息

data>>id[string]是无限制模板ID

data>>description[string]是无限制模板描述

data>>name[string]是无限制模板名字

data>>items[object]是无限制模板包含的字段

data>>items>>idType[string]是无限制字段英文名

data>>items>>maxLength[string]是无限制字段最长长度

data>>items>>minLength[string]是无限制字段最小长度

data>>items>>name[string]是无限制字段中文名

data>>items>>required[string]是无限制是否必填

message[string]否无限制操作信息

status[int]否无限制状态码

A.2.7常见错误信息

表A.7模板创建接口常见错误信息表

错误码错误信息

字段最小长度不能大于最大长度

字段名字不符合命名规范

400

必填项为空

该模板已被注册

500系统错误

A.3模板列表查询接口

A.3.1请求路径

6:8888/third/queryTemplate

A.3.2请求协议

HTTP

A.3.3请求方法

GET

A.3.4请求头部

8

T/CPCIF00XX—20XX

表A.8模板列表查询接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.3.5请求参数

A.3.5.1数据格式

Json

A.3.5.2外层数据结构

Object

表A.9模板列表查询接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

name[string]否无限制模板名(模糊查询)

A.3.6返回结果

A.3.6.1数据格式

Json

A.3.6.2外层数据结构

Object

表A.10模板列表查询接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

status[number]是无限制状态码

message[string]是无限制操作信息

data[array]是无限制模板数据

data>>id[number]是无限制模板id

data>>name[string]是无限制模板名字

data>>prefix[string]是无限制模板前缀

data>>description[string]是无限制模板描述

data>>version[string]是无限制版本号

data>>companyid[number]是无限制公司id

data>>createtime[string]是无限制创建时间

9

T/CPCIF00XX—20XX

A.4模板更新接口

A.4.1请求路径

6:8888/third/updateTemplate

A.4.2请求协议

HTTP

A.4.3请求方法

POST

A.4.4请求头部

表A.11模板更新接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.4.5请求参数

A.4.5.1数据格式

Json

A.4.5.2外层数据结构

Object

表A.12模板更新接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

id[int]是无限制模板id

name[string]是无限制模板名字

description[string]否无限制模板描述

items[array]是无限制模板包含的字段

字段英文名（英文字母开头，只

items>>idType[string]是255

能包含英文字母，下划线，数字）

items>>maxLength[int]是无限制字段最长长度

items>>minLength[int]是无限制字段最小长度

items>>name[string]是255字段中文名

是否必填（1是必填，0是非必

items>>required[int]否无限制

填，默认值为0）

10

T/CPCIF00XX—20XX

示例3：

{

"id":24,

"description":"设备信息标识模板",

"items":[

{

"name":"设备名称",

"idType":"Equip_name",

"required":"0",

"minLength":1,

"maxLength":20

}

]

}

A.4.6返回结果

A.4.6.1数据格式

Json

A.4.6.2外层数据结构

Object

表A.13模板更新接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

data[object]否无限制--

message[string]否无限制--

status[int]否无限制--

A.4.7常见错误信息

表A.14模板更新接口常见错误信息表

错误码错误信息

字段最小长度不能大于最大长度

字段名字不符合命名规范

400

必填项为空

该模板不存在

500系统错误

A.5应用注册接口

A.5.1请求路径

6:8888/third/registApplication

11

T/CPCIF00XX—20XX

A.5.2请求协议

HTTP

A.5.3请求方法

POST

A.5.4请求头部

表A.15应用注册接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.5.5请求参数

A.5.5.1数据格式

Json

A.5.5.2外层数据结构

Object

表A.16应用注册接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

name[string]是无限制应用名字

templateid[int]是无限制选用模板id

示例4：

{

"name":"产品追溯应用",

"templateid":35

}

A.5.6返回结果

A.5.6.1数据格式

Json

A.5.6.2外层数据结构

Object

12

T/CPCIF00XX—20XX

表A.17应用注册接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

data[object]是无限制--

data>>id[int]是无限制应用id

data>>name[string]是无限制应用名字

data>>templateid[string]是无限制选用模板id

message[string]否无限制状态码信息

status[int]否无限制状态码

A.5.7常见错误信息

表A.18应用注册接口常见错误信息表

错误码错误信息

应用已被注册

400

所选模板不存在

500系统错误

A.6标识数据注册接口

A.6.1请求路径

6:8888/third/registData

A.6.2请求协议

HTTP

A.6.3请求方法

POST

A.6.4请求头部

表A.19标识数据注册接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.6.5请求参数

A.6.5.1数据格式

Json

A.6.5.2外层数据结构

13

T/CPCIF00XX—20XX

Object

表A.20标识数据注册接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

applicationid[int]是无限制应用id

datas[array]是无限制标识数据列表

datas>>handle[string]是无限制标识数据的标识码

datas>>values[array]是无限制标识字段数据

datas>>values>>type[string]是255字段的英文名

datas>>values>>value[string]是无限制字段值

示例5：

{

"applicationId":18,

"datas":[

{

"handle":"88.399.101/1234567891011",

"values":[

{

"value":"离心泵",

"type":"Product_name"

}

]

}

]

}

A.6.6返回结果

A.6.6.1数据格式

Json

A.6.6.2外层数据结构

Object

表A.21标识数据注册接口返回结果数据结构信息表

参数名类型是否必填字段长度说明

data[array]是无限制标识注册结果

data>>handle[string]是无限制标识的handle值

data>>type[string]是无限制处理类型

data>>message[string]是无限制处理信息

message[string]是无限制操作信息

status[int]是无限制状态码

14

T/CPCIF00XX—20XX

A.6.7常见错误信息

表A.22标识数据注册接口常见错误信息表

错误码错误信息

应用不存在

有必填项未填写

400字段小于最小长度

字段大于最大长度

标识已被注册

500系统错误

A.7标识数据更新接口

A.7.1请求路径

6:8888/third/updateHandleValue

A.7.2请求协议

HTTP

A.7.3请求方法

POST

A.7.4请求头部

表A.23标识数据更新接口请求头部信息表

头部标签类型是否必填字段长度说明

Service-Key[string]是无限制调用服务token

A.7.5请求参数

A.7.5.1数据格式

Json

A.7.5.2外层数据结构

Object

15

T/CPCIF00XX—20XX

表A.24标识数据更新接口请求参数数据结构信息表

参数名类型是否必填字段长度说明

Applicationid[string]是无限制应用id

datas[object]是无限制待更新的标识数据列表

datas>>handle[string]是无限制标识handle值

datas>>values[array]是无限制标识字段数据

datas>>values>>type[string]是255字段的英文名

datas>>values>>value[string]是无限制字段值

示例6：

{

"applicationId":18,

"datas":[

{

"handle":"88.127.100001/1234567891011",

"values":[

{