面向MES的工业互联网标识数据采集与互通系统中间件接口规范

面向MES的工业互联网标识数据采集与互通系统中间件接口规范本文件规定了其他信息系统与中间件进行通讯时所使用的接口，包括报文的通讯结构、格式以及调用指令说明等要求。本文件适用于任何信息系统与任何接入该中间件的MES系统之间进行的数据采集、交换、共享和互联互通的场景。2规范性引用文件本文件没有规范性引用文件。3术语和定义下列术语和定义适用于本文件。3.1Handle由TCP/IP的联合发明人、有“互联网之父”之称的RoberKahn博士发明，核心系统由美国国家创新研究所（CNRI）开发。Handle在全球设立若干的根节点，根节点之间平等互通；可提供部分用户自定义的编码能力，用户可以根据实际需求在编码体系的部分字段自定义编码规则。3.2工业互联网标识industrialinternetidentification能够唯一识别机器、产品等物理资源和算法、工序等虚拟资源的身份符号，类似于“身份证”。3.3标识解析信息identityparsinginformation根据标识编码查询目标对象网络位置或者相关信息的系统装置，对机器和物品进行唯一性的定位并查询获取描述该对象的标识关联信息。3.4标识关联信息identifyassociatedinformation标识关联信息是组成标识解析信息的单元，是标识解析后所获得的描述标识对象的具体信息，一般采用Key-Value的形式存储，有多种关联信息的类型，如图片、网址、文本等，标识解析信息可以由多条标识关联信息组成。3.5中间件middleware2本文中间件是介于应用系统和MES系统之间的一类接口软件，它使用工业互联网标识所提供的基础服务功能，衔接企业内部或外部其他应用系统的各个部分或不同的应用，能够达到资源共享、功能共享的目的。3.6令牌pass代表执行某些操作的权限的对象，接口的调用需要认证令牌，类似“通行证”。3.7密钥secretkey密钥是一种参数，它是在明文转换为密文或将密文转换为明文的算法中输入的参数。3.8公钥publickey公钥是密钥对的对外公开的非秘密一半，对应另一半的是私密保存的私钥，使用这个密钥对的时候,如果用其中一个密钥加密一段数据，必须用另一个密钥解密。4符号和缩略语下列缩略语适用于本文件。MES：制造企业生产过程执行管理系统（ManufacturingExecutionSystem）SM4:国密分组密码算法（对称算法，用于加密）SM9:国密标识密码算法（非对称算法，用于签名）URL:统一资源定位器（UniformResourceLocator）DM:标识数据模板（DataModel），一般为多条标识关联信息的集合RelateInfo:标识关联信息对象5具体接口规范5.1概述该接口规范无限定任何开发语言，任一开发语言皆可按照本规范要求的接口命名、接口功能以及传入传出参数类型设计。下述接口规范是按照JAVA开发语言习惯编写，其他开发语言可参照相同或类似的数据类型进行替换映射。5.2基础服务类接口5.2.1初始化中间件5.2.2释放中间件5.2.3更新数据模板调用该中间件接口，会将用户在标识自助平台中配置的标识数据模板下载5.2.4更新权限令牌调用该接口，中间件将会重新向标识平台申请一个新的权限令牌（token）5.3安全服务类接口5.3.1生成业务密钥调用该接口，中间件将会创建一个业务密钥（对称密钥SM4）。该业务密钥将会用于对标识45.3.2获取中间件公钥5.3.3加密业务密钥），5.3.4解密业务密钥），5.3.5查询业务密钥queryBusSecretKey(St需要进行解密的中间件标识号,默认为当前中间5.3.6标识数据分享shareHandle(StringhandleCode,List<MvPublicKey>t5.4数据结构化接口5.4.1生成标识关联信息数据（根据数据模板）调用该接口，中间件将会根据标识数据模板生成标准5.4.2生成一条标识关联信息（TEXT类型）genRelateInfoText(intindex,Stringlabel,Strin65.4.3生成一条标识关联信息（LINK类型）5.4.4生成一条标识关联信息（Textarea类型）genRelateInfoTextarea(intindex,Stringlabel,String5.4.5生成一条标识关联信息（HTML类型）genRelateInfoHtml(intindex,Stringlabel,S5.4.6生成一条标识关联信息（IMAGE类型）genRelateInfoImage(intindex,Stri5.4.7生成一条标识关联信息（IMAGE_BIG类型）5.4.8生成一条标识关联信息（VIDEO类型）genRelateInfoVideo(intindex,Stringlabel,String调用该接口，中间件将会生成一个标准的VIDEO类型的标识关联数据对象。（传入视频URL5.4.9生成一条标识关联信息（URL类型）8genRelateInfoUrl(intindex,Strin5.4.10生成一条标识关联信息（PARENT类型）表20genRelateInfoParent(intindex,Strin5.4.11生成一条标识关联信息（CHILD类型）表21genRelateInfoChild(intindex,Stri5.4.12生成一条标识关联信息（DATA_STRING类型）表22调用该接口，中间件将会生成一个标准的DATA_5.4.13生成一条标识关联信息（DATA_NUMBER类型）表23调用该接口，中间件将会生成一个标准的DATA_5.4.14生成一条标识关联信息（DATA_DATETIME类型）表24genRelateInfoDataDatetime(intindex,Stringkey,Datevalue,bool调用该接口，中间件将会生成一个标准的DATA_DA5.4.15生成一条标识关联信息（DATA_JSONOBJECT类型）表25调用该接口，中间件将会生成一个标准的DATA_JSON5.4.16生成一条标识关联信息（DATA_JSONARRAY类型）表26调用该接口，中间件将会生成一个标准的DATA_JS5.4.17生成一条标识关联信息（DATA_BASE64类型）表27genRelateInfoDataBase64(intindex,Stringkey,Stringbase64Str,bool调用该接口，中间件将会生成一个标准的DATA_5.4.18生成一条标识关联信息（DATA_INT类型）表28genRelateInfoDataInt(intindex,Stringkey,String调用该接口，中间件将会生成一个标准的D5.4.19生成一条标识关联信息（DATA_DOUBLE类型）表29genRelateInfoDataDouble(intindex,Stringkey,doublev调用该接口，中间件将会生成一个标准的DATA_5.5数据互通类接口executeApi(StringapiHandle,Strin5.6标识应用接口5.6.1生成标识码createHandleCode(Bus5.6.2创建标识5.6.3解析标识queryHandle(StringhandleCode,Stringbus调用该接口，中间件将会解析一个标识码，5.6.4注销标识removeHandle(Stringhandl5.6.5添加标识关联信息addRelateInfo(StringhandleCode,RelateInfoinfo,StringbusSec5.6.6修改标识关联信息modifyRelateInfo(StringhandleCode,RelateInfoinfo,StringbusSecretK5.6.7删除标识关联信息removeRelateInfo(StringremoveRelateInfo(Str5.6.8批量创建标识batchCreateHandle(List<BatchHandleVo>batchHandl5.6.1查询批量创建标识进度表40queryBatchCreateProcess(St5.7错误码定义5.7.1接口错误码#002000001)错误码含义：标识API服务未知异常。2)建议解决方法：请与系统管理员联系。#002000011)错误码含义：接口必填参数为空或没有传入。2)建议解决方法：请正确传入接口参数。#002000021)错误码含义：解析输入参数出错。2)建议解决方法：请检查数据输入格式。#002000031)错误码含义：输入参数的code值与数据模板中的code不一致。2)建议解决方法：请确保输入数据与数据模板数据相一致。#002000041)错误码含义：数据存在相同的索引号(index)。2)建议解决方法：数据索引号(index)不能重复。#002000051)错误码含义：上传文件过大。2)建议解决方法：请调整文件大小。#002000061)错误码含义：文件解base64编码错误。2)建议解决方法：文件必须经过base64编码。#002000071)错误码含义：标识查询错误。2)建议解决方法：请检查标识号是否存在。#002000081)错误码含义：添加标识属性发生错误。2)建议解决方法：请检查输入数据是否正确。#002000091)错误码含义：解析JSON数据时出错。2)建议解决方法：请检查输入数据是否正确。#002000101)错误码含义：输入参数缺少code值。2)建议解决方法：请检查输入数据是否正确。#002000111)错误码含义：IMAGE图片过大。2)建议解决方法：IMAGE图片不能大于300KB。#002000121)错误码含义：index值为null。2)建议解决方法：index值不能为null，且index值不能重复。#002000131)错误码含义：code值为null。2)建议解决方法：code值不能为null，且code值不能重复。#002000141)错误码含义：code值重复。2)建议解决方法：code值不能为null，且code值不能重复。#002000151)错误码含义：数据模板转换IMAGE出错。2)建议解决方法：请与系统管理员联系。#002000161)错误码含义：index值不能为空。2)建议解决方法：请输入index值。#002000171)错误码含义：index值为null。2)建议解决方法：index值不能为null，且index值不能重复。#002000181)错误码含义：index值重复。2)建议解决方法：index值不能为null，且index值不能重复。#002000191)错误码含义：数据模板不存在。2)建议解决方法：请检查数据模板编号(datattemplate)是否正确。#002000201)错误码含义：标识码不存在。2)建议解决方法：请重新输入标识码。#002000211)错误码含义：展示模板不能为空。2)建议解决方法：请传入viewId。#002000221)错误码含义：标识号不能为空。2)建议解决方法：请提供标识号。#002000231)错误码含义：展示模板不存在。2)建议解决方法：请提供已存在的展示模板。#002000241)错误码含义：排序数组格式错误。2)建议解决方法：正确格式[2,3,4]。#002000251)错误码含义：排序数据不能为空。2)建议解决方法：置空排序可以设置为空串。#002000261)错误码含义：auth不能为空。2)建议解决方法：请传入auth。#002000271)错误码含义：只能申请88.168.开头的合法标识。2)建议解决方法：请重新输入标识号(如:88.168.100)。#002000281)错误码含义：用户不存在。2)建议解决方法：输入正确的username。#002000291)错误码含义：业务单号不存在。2)建议解决方法：输入正确的业务单号。#002000301)错误码含义：相关信息为空。2)建议解决方法：重新输入参数。#002000311)错误码含义：地区格式不正确。2)建议解决方法：正确格式:中国-广东省-深圳市-南山区。#002000321)错误码含义：未找到指定地区。2)建议解决方法：参照格式:中国-广东省-深圳市-南山区。#002000331)错误码含义：企业类型填写错误。2)建议解决方法：必须是政府机关,研究机构,社会团体,企业事业单位子集。#002000341)错误码含义：图片大小不能超过500k。2)建议解决方法：请重新选择图片。#002000351)错误码含义：文件非base64编码。2)建议解决方法：上传base64编码后的文件。5.7.2安全错误码#id="00100000"1)错误码含义：安全服务未知异常。2)建议解决方法：请与系统管理员联系。#id="00100001"1)错误码含义：接口必填参数为空或没有传入。2)建议解决方法：请正确传入接口参数。#id="00100002"1)错误码含义：没有进行实时验签配置。2)建议解决方法：请与管理员联系。#id="00100003"1)错误码含义：数据验签错误。2)建议解决方法：请与管理员联系。#id="00100004"1)错误码含义：数据验签不通过。2)建议解决方法：请传入正确的数据签名值。#id="00100005"1)错误码含义：没有配置主密钥。2)建议解决方法：请与管理员联系。#id="00100006"1)错误码含义：没有进行API服务接口http地址配置。2)建议解决方法：请与管理员联系。#id="00100007"1)错误码含义：调用API服务出错。2)建议解决方法：请与管理员联系。#id="00100008"1)错误码含义：未找到相关用户信息。2)建议解决方法：请提供正确的用户账户#id="00100009"1)错误码含义：token失效。2)建议解决方法：重新申请token。#id="00100010"1)错误码含义：token