鑫興科技(jì) > API介紹
API文檔

簡介

歡迎您使用工業互聯網标識公共服務平台，我們提供了豐富的 API 供您對标識進行(xíng)管理(lǐ)。如果您熟悉網絡服務協議和(hé)一種以上(shàng)編程語言，我們推薦您使用HTTP API接口來(lái)管理(lǐ)您的标識和(hé)開(kāi)發自己的應用程序。假如您不太熟悉網絡協議，我們也專門(mén)為(wèi)您提供了更簡便的SDK API接口。


HTTP API接口

假如您熟悉網絡服務協議和(hé)數(shù)據加密技(jì)術(shù)，那(nà)麽我們推薦您使用HTTP API接口來(lái)管理(lǐ)您的标識和(hé)開(kāi)發應用系統。

創建标識接口

接口名稱
創建标識接口
接口地址
https://api.gdsinsing.com/safety/api/create-identifier
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handlename: 标識前綴,
  handleid: 标識自定義碼,
  datatemplate: 數(shù)據模闆編号,
  viewtemplate: 展現模闆編号(可(kě)選),
  value: [{
    code: 數(shù)據模闆索引号(必填),
    value: 值,
    display: 顯示值
  }]
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
string 标識碼
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

通(tōng)用創建标識接口

接口名稱
通(tōng)用創建标識
接口地址
https://api.gdsinsing.com/safety/api/create-identifier-common
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handlename: 标識前綴,
  handleid: 标識自定義碼,
  viewtemplate: 展現模闆編号(可(kě)選),
  value: [
    index: 标識關聯信息索引值(數(shù)字),
    type: TEXT （關聯信息類型）,
    label: 标題,
    value: 值,
    display: 顯示值,
    rule: 正則表達式,
    repval: 正則表達式替換值,
    references: 下級标識碼,
    readauth: 可(kě)讀權限,
    writeauth: 可(kě)寫權限
  }]
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
string 标識碼
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

标識解析接口

接口名稱
标識解析
接口地址
https://api.gdsinsing.com/safety/api/query-identifier
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handle: 标識碼 (88.168.1/abc),
  indexs: 标識值索引号[1,2,….](可(kě)為(wèi)空(kōng)),
  types: TEXT(關聯信息類型)
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
JsonArray [{
  index: 索引值,
  type: 顯示類型,
  data: {
    format: string,
    value: 列值
  },
  references: [{
    handle: 下級标識号,
    index: 索引
  }]
}]
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

删除标識接口

接口名稱
删除标識
接口地址
https://api.gdsinsing.com/safety/api/remove-identifier
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string 标識号(88.168.1/abc)
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（handle+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

添加标識關聯信息接口

接口名稱
添加标識關聯信息
接口地址
https://api.gdsinsing.com/safety/api/add-identifier-attr
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handle:标識号,
  value: [
    index: 标識關聯信息索引值(數(shù)字),
    type: TEXT （關聯信息類型）,
    label: 标題,
    value: 值,
    display: 顯示值,
    rule: 正則表達式,
    repval: 正則表達式替換值,
    references: 下級标識碼,
    readauth: 可(kě)讀權限,
    writeauth: 可(kě)寫權限
  }]
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

修改标識關聯信息接口

接口名稱
修改标識關聯信息
接口地址
https://api.gdsinsing.com/safety/api/modify-identifier-attr
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handle:标識号,
  value: [
    index: 标識關聯信息索引值(數(shù)字),
    type: TEXT （關聯信息類型）,
    label: 标題,
    value: 值,
    display: 顯示值,
    rule: 正則表達式,
    repval: 正則表達式替換值,
    references: 下級标識碼,
    readauth: 可(kě)讀權限,
    writeauth: 可(kě)寫權限
  }]
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法

删除标識關聯信息接口

接口名稱
删除标識關聯信息
接口地址
https://api.gdsinsing.com/safety/api/remove-identifier-attr
請(qǐng)求方法
POST
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
string 企業賬号(标識前綴)
string {
  handle: 标識号,
  index: [1,2,3]
}
string {
  timestamp: 時(shí)間(jiān)戳(可(kě)為(wèi)空(kōng)),
  sign:（jsonData+timestamp）取哈希值(sha256)，然後進行(xíng)數(shù)字(SM9)簽名
}
成功返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 1:成功，0:失敗
失敗返回
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
int 0
string 錯誤碼
string 異常描述
string 解決辦法


SDK API接口

假如您對網絡協議和(hé)數(shù)據加密技(jì)術(shù)不太熟悉，我們為(wèi)您提供了SDK API接口。SDK接口将會(huì)為(wèi)您屏蔽掉網絡發送過程和(hé)數(shù)據加密過程，您隻需要調用我們SDK中的接口方法，就能輕松地對标識進行(xíng)管理(lǐ)和(hé)應用系統開(kāi)發。

創建标識接口

接口名稱
創建标識
接口方法
public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識前綴
String 标識自定義碼
String 數(shù)據模闆編号
String 展示模闆編号(可(kě)為(wèi)空(kōng))
List 标識關聯數(shù)據
返回值
标識碼

通(tōng)用創建标識接口

接口名稱
通(tōng)用創建标識
接口方法
public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識前綴
String 标識自定義碼
String 數(shù)據模闆編号
String 展示模闆編号(可(kě)為(wèi)空(kōng))
List<RelateData> 标識關聯數(shù)據
返回值
标識碼

标識解析接口

接口名稱
标識解析
接口方法
public List<RelateData> queryIdentifier(String handle) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
返回值
标識關聯信息

标識解析接口

接口名稱
标識解析
接口方法
public List<RelateData> queryIdentifier(String handle, int[] indexs, String[] types) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
int[] 關聯信息索引(可(kě)為(wèi)null)
String[] 關聯信息類型(可(kě)為(wèi)null)
返回值
标識關聯信息

删除标識接口

接口名稱
删除标識
接口方法
public void removeIdentifier(String handle) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
返回值

添加标識關聯屬性接口

接口名稱
添加标識關聯屬性
接口方法
public void addIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
List<RelateInfo> 标識關聯信息
返回值

修改标識關聯屬性接口

接口名稱
修改标識關聯屬性
接口方法
public void modifyIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
List<RelateInfo> 标識關聯信息
返回值

删除标識關聯屬性接口

接口名稱
删除标識關聯屬性
接口方法
public void removeIdentifierAttr(String handle, int[] indexs) throws Exception
接口參數(shù)
參數(shù)名稱 參數(shù)類型 參數(shù)說明(míng)
String 标識碼
int[] 關聯信息索引(可(kě)為(wèi)null)
返回值