鑫兴科技 > API介绍
API文档

简介

欢迎您使用工业互联网标识公共服务平台，我们提供了丰富的 API 供您对标识进行管理。如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用HTTP API接口来管理您的标识和开发自己的应用程序。假如您不太熟悉网络协议，我们也专门为您提供了更简便的SDK API接口。


HTTP API接口

假如您熟悉网络服务协议和数据加密技术，那么我们推荐您使用HTTP API接口来管理您的标识和开发应用系统。

创建标识接口

接口名称
创建标识接口
接口地址
https://api.gdsinsing.com/safety/api/create-identifier
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handlename: 标识前缀,
  handleid: 标识自定义码,
  datatemplate: 数据模板编号,
  viewtemplate: 展现模板编号(可选),
  value: [{
    code: 数据模板索引号(必填),
    value: 值,
    display: 显示值
  }]
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
string 标识码
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

通用创建标识接口

接口名称
通用创建标识
接口地址
https://api.gdsinsing.com/safety/api/create-identifier-common
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handlename: 标识前缀,
  handleid: 标识自定义码,
  viewtemplate: 展现模板编号(可选),
  value: [
    index: 标识关联信息索引值(数字),
    type: TEXT （关联信息类型）,
    label: 标题,
    value: 值,
    display: 显示值,
    rule: 正则表达式,
    repval: 正则表达式替换值,
    references: 下级标识码,
    readauth: 可读权限,
    writeauth: 可写权限
  }]
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
string 标识码
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

标识解析接口

接口名称
标识解析
接口地址
https://api.gdsinsing.com/safety/api/query-identifier
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handle: 标识码 (88.168.1/abc),
  indexs: 标识值索引号[1,2,….](可为空),
  types: TEXT(关联信息类型)
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
JsonArray [{
  index: 索引值,
  type: 显示类型,
  data: {
    format: string,
    value: 列值
  },
  references: [{
    handle: 下级标识号,
    index: 索引
  }]
}]
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

删除标识接口

接口名称
删除标识
接口地址
https://api.gdsinsing.com/safety/api/remove-identifier
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string 标识号(88.168.1/abc)
string {
  timestamp: 时间戳(可为空),
  sign:（handle+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

添加标识关联信息接口

接口名称
添加标识关联信息
接口地址
https://api.gdsinsing.com/safety/api/add-identifier-attr
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handle:标识号,
  value: [
    index: 标识关联信息索引值(数字),
    type: TEXT （关联信息类型）,
    label: 标题,
    value: 值,
    display: 显示值,
    rule: 正则表达式,
    repval: 正则表达式替换值,
    references: 下级标识码,
    readauth: 可读权限,
    writeauth: 可写权限
  }]
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

修改标识关联信息接口

接口名称
修改标识关联信息
接口地址
https://api.gdsinsing.com/safety/api/modify-identifier-attr
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handle:标识号,
  value: [
    index: 标识关联信息索引值(数字),
    type: TEXT （关联信息类型）,
    label: 标题,
    value: 值,
    display: 显示值,
    rule: 正则表达式,
    repval: 正则表达式替换值,
    references: 下级标识码,
    readauth: 可读权限,
    writeauth: 可写权限
  }]
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法

删除标识关联信息接口

接口名称
删除标识关联信息
接口地址
https://api.gdsinsing.com/safety/api/remove-identifier-attr
请求方法
POST
接口参数
参数名称 参数类型 参数说明
string 企业账号(标识前缀)
string {
  handle: 标识号,
  index: [1,2,3]
}
string {
  timestamp: 时间戳(可为空),
  sign:（jsonData+timestamp）取哈希值(sha256)，然后进行数字(SM9)签名
}
成功返回
参数名称 参数类型 参数说明
int 1:成功，0:失败
失败返回
参数名称 参数类型 参数说明
int 0
string 错误码
string 异常描述
string 解决办法


SDK API接口

假如您对网络协议和数据加密技术不太熟悉，我们为您提供了SDK API接口。SDK接口将会为您屏蔽掉网络发送过程和数据加密过程，您只需要调用我们SDK中的接口方法，就能轻松地对标识进行管理和应用系统开发。

创建标识接口

接口名称
创建标识
接口方法
public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识前缀
String 标识自定义码
String 数据模板编号
String 展示模板编号(可为空)
List 标识关联数据
返回值
标识码

通用创建标识接口

接口名称
通用创建标识
接口方法
public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识前缀
String 标识自定义码
String 数据模板编号
String 展示模板编号(可为空)
List<RelateData> 标识关联数据
返回值
标识码

标识解析接口

接口名称
标识解析
接口方法
public List<RelateData> queryIdentifier(String handle) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
返回值
标识关联信息

标识解析接口

接口名称
标识解析
接口方法
public List<RelateData> queryIdentifier(String handle, int[] indexs, String[] types) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
int[] 关联信息索引(可为null)
String[] 关联信息类型(可为null)
返回值
标识关联信息

删除标识接口

接口名称
删除标识
接口方法
public void removeIdentifier(String handle) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
返回值

添加标识关联属性接口

接口名称
添加标识关联属性
接口方法
public void addIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
List<RelateInfo> 标识关联信息
返回值

修改标识关联属性接口

接口名称
修改标识关联属性
接口方法
public void modifyIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
List<RelateInfo> 标识关联信息
返回值

删除标识关联属性接口

接口名称
删除标识关联属性
接口方法
public void removeIdentifierAttr(String handle, int[] indexs) throws Exception
接口参数
参数名称 参数类型 参数说明
String 标识码
int[] 关联信息索引(可为null)
返回值