ICS 55.180.10 A 85 T/SCA 018—2021 工业互联网集装箱二级节点平台应用接口 规范 Application interface specification for secondary -level node platform of freight container 2021 – 10 - 08发布 2021 - 11- 08实施 深圳市智能集装箱技术协会 发布 团体标准 T/SCA 全国团体标准信息平台 T/SCA全国团体标准信息平台 T/SCA 018-2021 Ⅰ 目 次 前言 .................................................................................. Ⅰ 1 范围 .............................................................................. 1 2 规范性引用文件 .................................................................... 1 3 术语和定义 ........................................................................ 1 4 系统对接流程与要求 ................................................................ 1 5 数据交换格式 ...................................................................... 2 6 通信安全机制 ...................................................................... 9 T/SCA 全国团体标准信息平台 T/SCA 018-2021 II 前 言 本文件按照 GB/T 1.1 ―2020《标准化工作导则 第1部分：标准化文件的结构和起草规则》的规定 起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。 本文件由深圳市智能集装箱技术协会提出并归口。 本文件起草单位： 深圳中集智能科技有限公司、深圳市标准技术研究院、 交通运输部水运科学研究 所、上海理想信息产业 （集团）有限公司、厦门卫星定位应用股份有限公司。 本文件主要起草人：周受钦 、刘浩、李继春、李媛红 、权进国、 易晓珊、张曙光、盛骏、 张旭杰、 杨小明、廖星星、吕洁印、 李大命、文常强、江培舟、李志扬、李佳骏、陈雷。 T/SCA 全国团体标准信息平台 T/SCA 018-2021 1 工业互联网集装箱二级节点平台应用接口规范 1 范围 本文件规定了 工业互联网集装箱二级节点 平台与第三方平台 之间数据通信的对接流程 与要求、数 据交换格式和通信安全机制。 本文件适用于工业互联网集装箱二级节点平台与第三方平台 之间的数据交换。 2 规范性引用文件 下列文件对于本文件的应用是必不可少的。 凡是注日期的引用文件， 仅注日期的版本适用于本文件。 凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 T/SCA 013 工业互联网标识解析 集装箱 标识编码规范 3 术语和定义 下列术语和定义适用于本文件。 3.1 集装箱身份标识 集装箱身份标识包括标识前缀和标识后缀两部分， 前缀与后缀之间以UTF -8字符“/”分隔，其中标 识前缀由国家代码、行业代码、企业代码组成，用于唯一标识企业主体；标识后缀由物品类别代码、物 品名称代码、物品型号规格代码、物品序列号代码、日期代码、企业内部物品编码和其他项组成，其他项为可选，用于唯一识别标识对象。 3.2 工业互联网 集装箱二级节点 平台 能够实现集装箱身份标识注册 、解析、检索，企业信息注册、企业信息审核、 集装箱数据上报 、历 史数据追溯 ， 并能够实现跟国家顶级节点对接 的工业互联网标识解析平台 。本文件中简称为集装箱平台。 4 对接流程与 要求 4.1 对接流程 第三方平台 与集装箱平台之间的对接流程如下： a) 在集装箱平台进行账号注册 ； b) 利用已注册的账号、密码登录平台， 通过API接口获取 UserToken； c) 设置服务器的 IP地址或域名 ，通过UserToken 请求名下集装箱标识列表 ； d) 根据业务需求，选择主动请求数据或被动接收数据。 T/SCA 全国团体标准信息平台 T/SCA 018-2021 2 4.2 主动方式 主动方式是指第三方平台主动请求集装箱平台数据，包括： a) 通过UserToken 和集装箱标识 ，请求集装箱最新数据； b) 通过UserToken 、集装箱标识 、时间范围 ，请求集装箱历史数据。 4.3 被动方式 被动方式是指第三方平台被动接收来自集装箱平台的数据，步骤如下 ： a) 用户设置第三方平台接收数据的 URL地址； b) 集装箱平台接收到数据后，主动请求第三方 URL地址，实现数据推送。 5 数据交换格式 5.1 数据格式定义 第三方平台与 集装箱平台之间进行数据对接采用HTTP /HTTPS协议。请求参数为URL参数，返回数据 格式为JSON，字符编码为UTF -8，消息总长度应不超过 100K字节。 5.2 获取Usertoken 5.2.1 接口调用地址 接口调用地址为：user /login。 5.2.2 请求方式 采用HTTP/HTTPS 协议的POST请求方式。 5.2.3 请求参数说明 POST请求参数如表 1所示。 表1 请求参数说明 参数名 数据类型 数据长度 是否必须 说 明 userName String 6-20 是 用户名/账号 password String 6-20 是 密码 5.2.4 返回说明 5.2.4.1 正常情况 平台返回下述 JSON数据包给调用端 ： { "errorCode": 200, "message": "Success", "data": { "userToken": "s*EK0B8GsS5LEE1V*HW1*w==", ................................. "mqttToken": "vC3JALZ4UrmjqswA3izD2Q==", "groupData": null T/SCA 全国团体标准信息平台 T/SCA 018-2021 3 }, "success": true } 5.2.4.2 错误情况 平台返回错误码等信息 给调用端，错误码说明如表2 所示。 表2 错误码说明 错误码/状态码 说 明 200 正常 404 找不到所请求的数据 500 服务器错误 ，具体错误会在 message中返回 示例： {"errcode":500,"message":" 用户名或密码不正确"} 5.3 服务器IP地址或域名设置 5.3.1 接口调用地址 接口调用地址为：sys/setIps。 5.3.2 请求方式 采用HTTP/HTTPS 协议的POST请求方式。 5.3.3 请求参数说明 POST请求参数如表 3所示。 表3 请求参数说明 参数名 数据类型 数据长度 是否必须 说 明 userToken String 10-100 是 用户token ips String 10-100 是 IP地址或域名 。 目前IP地址只支持 IPv4，格式 为xxx.xxx.xxx.xxx。 示例： 110.110.110.110 域名格式 为xxx.xxx.xxx。 示 例：baidu.com 注1：如果用多个 IP地址或域 名，需要用英文逗号隔开。 注2：域名不需要加http、 https、斜杠等。 5.3.4 返回说明 5.3.4.1 正常情况 平台返回下述 JSON数据包给调用端 ： { "errorCode": 200, "message": "Success", T/SCA 全国团体标准信息平台 T/SCA 018-2021 4 "success": true } 5.3.4.2 错误情况 平台返回错误码等信息 给调用端。 示例： {"errcode":500,"message":" 设置失败"} 5.4 请求所有集装箱标识列表 5.4.1 接口调用地址 接口调用地址为：containernode/getContainerNodeList。 5.4.2 请求方式 采用HTTP/HTTPS 协议的POST请求方式。 5.4.3 请求参数说明 POST请求参数如表 4所示。 表4 请求参数说明 参数名 数据类型 数据长度 是否必须 说 明 use