ICS35.100 L79 团体标准 T/GDMIA005-2020 家电行业工业互联网国家二级节点平台 技术规范接口规范 Interfacespecificationofnationalsecondarynodeplatformtechnical specificationforhomeapplianceindustry 2020年6月10日发布 2020年6月20日实施 广东省机械行业协会发布 全国团体标准信息平台 全国团体标准信息平台 T/GDMIA005-2020 I目次 前言...............................................................................................................................................Ⅱ 1范围...............................................................................................................................................1 2规范性引用文件...........................................................................................................................1 3术语和定义...................................................................................................................................1 4系统接口要求...............................................................................................................................2 5接口模型及参数...........................................................................................................................4 附录A（规范性）接口及其参数说明.............................................................................................6 附录B（规范性）错误分类代码...................................................................................................21 全国团体标准信息平台 T/GDMIA005-2020 II前言 本文件按照GB/T1.1-2009给出的规则起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本文件由广东省机械行业协会标准化委员会工业互联网工作组提出。 本文件由广东省机械行业协会标准化委员会归口。 本文件起草单位：美的集团股份有限公司、广东美云智数科技有限公司、广东鑫兴科技有限公司、 广东省机械行业协会。 本文件主要起草人：成德金、周晓钢、谭奥琪、汪毅、吴志忠、张桂明、李兰芳。 全国团体标准信息平台 T/GDMIA005-2020 1家电行业国家二级节点平台技术规范接口规范 1范围 本文件规定了国家顶级节点、企业节点与家电行业国家二级节点平台进行对接或数据交换的接口规 范。 本文件适用于外部系统与家电行业国家二级节点平台的接口，完成产品、标识等信息的交换。 2规范性引用文件 下列文件对于本文件的应用是必不可少的。但是注日期的引用文件，仅注日期的版本适用于本文件。 凡是不注日期的文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T29798基于Web服务的IT资源管理规范 3术语和定义 GB/T29798及下列术语和定义适用于本文件。 3.1国家二级节点平台secondarynodeplatform（SNP) 是一个行业或者区域内部的标识解析公共服务节点，能够面向行业或区域提供标识编码注册和标识 解析服务，以及完成相关的标识业务管理、标识应用对接等。本文件特指美的集团份有限公司承建的国 家家电行业标识解析二级节点平台。 3.2请求方Request 发起请求的用户角色，Request对象的作用是与客户端交互，收集客户端的Form、Cookies、超链接， 或者收集服务器端的环境变量。request对象是从客户端向服务器发出请求，包括用户提交的信息以及 客户端的一些信息。 3.3实现方Implementer 实现接口具体业务逻辑的开发角色。 3.4授权Authorization 根据用户提供的身份凭证，生成权限实体，并为之授予相应的权限。调用的许可，如果没有对调用 方的授权那么对方是不可以调用服务的。 3.5验签CheckSign 为了防止接口被攻击，需要在服务端做验签的逻辑，校验请求的合法性。 3.6分布式搜索引擎系统elasticsearch（ES） 是一个基于Lucene的搜索服务器。它提供了一个分布式多用户能力的全文搜索引擎，基于RESTful web接口。Elasticsearch主要用于云计算中，能够达到实时搜索，稳定，可靠，快速，安装使用方便。 3.7表征状态转移RepresentationalStateTransfer（REST） 全国团体标准信息平台 T/GDMIA005-2020 2是一组架构约束条件和原则。 4系统接口要求 4.1接口组成 4.1.1概述 家电行业国家二级节点平台接口系统应包括登录接口、产品分页查询接口、产品新增接口、产品启 用接口、产品模板分页查询接口、产品模板新增接口、标识创建接口、标识状态更新接口和标识查询接 口。 4.1.2登录接口 应支持用户名和密码通过验证、密码加密、不通过报错返回等功能。 4.1.3产品分页查询接口 应支持产品信息（包含产品编码、名称、模板编码、模板名称、产品序列号等）查询等功能。 4.1.4产品新增接口 应支持新增产品的产品信息（包含产品编码、名称、模板编码、模板名称、产品序列号等）及明细 属性的存储插入等功能。 4.1.5产品启用接口 应支持禁用状态产品的启用等功能。 4.1.6产品模板分页查询接口 应支持产品模板信息（包含产品模板编码，名称，描述）查询等功能。 4.1.7产品模板新增接口 应支持新增产品模板的信息（包含模板编码、模板名称、描述）及明细属性的存储插入等功能。 4.1.8标识创建接口 应支持标识信息（包含标识编码、产品序列号、产品编码、产品名称、企业前缀等）及明细属性的 存储插入等功能。 4.1.9标识状态更新接口 应支持标识的状态启用、停用等功能。 4.1.10标识查询接口 应支持标识信息（包含标识编码、产品序列号、产品编码、产品名称、企业前缀等）及明细属性的 查询功能。 4.1.11查询当前企业用户产品标识注册解析量接口 应支持针对单个企业的产品标识注册解析数据量的统计，按照不同时间维度展示，例如按照周、月、 年维度进行统计汇总。 全国团体标准信息平台 T/GDMIA005-2020 34.2接口技术要求 ——采用基于RestAPI接口； ——数据的请求和返回结果采用JSON格式； ——应支持跨系统、跨平台调用。 4.3接口使用流程 4.3.1接口使用流程参考 接口使用可以参考以下流程： 图1接口使用流程图 4.3.2业务接口需要登录后才可以对SNP系统业务方面的产品、标识等功能操作。 4.3.3通过Https方式调用SNP-API接口，接口遵循REST规范，所有的请求和响应数据编码皆为utf-8 格式，请求的Content-Type是application/json；请求参数包括公共参数和业务参数。公共参数是所 有请求必须有的参数，如用户请求的认证、验签等。 4.3.4要求请求头中必须带有accessToken。 例如： Content-Type:application/json accessToken:XXXXXXXXXXXX 注：传输使用https加密协议、json数据交换格式，须支持http协议。 5接口模型及参数 5.1请求模型 全国团体标准信息平台 T/GDMIA005-2020 4图2接口请求模型 5.2返回模型 图3接口返回模型 5.3接口参数 接口的具体请求和返回参数应符合附录A要求。 调用接口返回错误分类代码的详细说明请参照附录B。返回数据模型结果代码 数据集 附件集单个数据数据名 数据值 数据类型请求模型 参数集接口名 附件集单个参数 单个附件参数名 参数值 参数类型 附件链接地址附件名 附件类型 附件内容 附件描述 全国团体标准信息平台 T/GDMIA005-2020 5附录A （规范性） 接口及其参数说明 A.1登录接口 A.1.1简要描述 登录SNP系统获取登录令牌。 A.1.2请求URL {HOST}/exLogin A.1.3请求方式 GET 表A.1登录接口请求参数表 参数名 参数说明 备注 userCode 用户账号 SNP系统管理员提供 secretKey