簡介

歡迎您使用工業互聯網標識公共服務平臺，我們提供了豐富的 API 供您對標識進行管理。如果您熟悉網絡服務協議和一種以上編程語言，我們推薦您使用HTTP API接口來管理您的標識和開發自己的應用程序。假如您不太熟悉網絡協議，我們也專門為您提供了更簡便的SDK API接口。

HTTP API接口

假如您熟悉網絡服務協議和數據加密技術，那么我們推薦您使用HTTP API接口來管理您的標識和開發應用系統。

創建標識接口

接口名稱

創建標識接口

接口地址

https://api.gdsinsing.com/safety/api/create-identifier

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handlename: 標識前綴, handleid: 標識自定義碼, datatemplate: 數據模板編號, viewtemplate: 展現模板編號(可選), value: [{ code: 數據模板索引號(必填), value: 值, display: 顯示值 }] }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗
data	string	標識碼

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

通用創建標識接口

接口名稱

通用創建標識

接口地址

https://api.gdsinsing.com/safety/api/create-identifier-common

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handlename: 標識前綴, handleid: 標識自定義碼, viewtemplate: 展現模板編號(可選), value: [ index: 標識關聯信息索引值(數字), type: TEXT （關聯信息類型）, label: 標題, value: 值, display: 顯示值, rule: 正則表達式, repval: 正則表達式替換值, references: 下級標識碼, readauth: 可讀權限, writeauth: 可寫權限 }] }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗
data	string	標識碼

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

標識解析接口

接口名稱

標識解析

接口地址

https://api.gdsinsing.com/safety/api/query-identifier

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handle: 標識碼 (88.168.1/abc), indexs: 標識值索引號[1,2,….](可為空), types: TEXT(關聯信息類型) }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗
data	JsonArray	`[{ index: 索引值, type: 顯示類型, data: { format: string, value: 列值 }, references: [{ handle: 下級標識號, index: 索引 }] }]`

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

刪除標識接口

接口名稱

刪除標識

接口地址

https://api.gdsinsing.com/safety/api/remove-identifier

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
handle	string	標識號(88.168.1/abc)
sign	string	`{ timestamp: 時間戳(可為空), sign:（handle+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

添加標識關聯信息接口

接口名稱

添加標識關聯信息

接口地址

https://api.gdsinsing.com/safety/api/add-identifier-attr

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handle:標識號, value: [ index: 標識關聯信息索引值(數字), type: TEXT （關聯信息類型）, label: 標題, value: 值, display: 顯示值, rule: 正則表達式, repval: 正則表達式替換值, references: 下級標識碼, readauth: 可讀權限, writeauth: 可寫權限 }] }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

修改標識關聯信息接口

接口名稱

修改標識關聯信息

接口地址

https://api.gdsinsing.com/safety/api/modify-identifier-attr

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handle:標識號, value: [ index: 標識關聯信息索引值(數字), type: TEXT （關聯信息類型）, label: 標題, value: 值, display: 顯示值, rule: 正則表達式, repval: 正則表達式替換值, references: 下級標識碼, readauth: 可讀權限, writeauth: 可寫權限 }] }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

刪除標識關聯信息接口

接口名稱

刪除標識關聯信息

接口地址

https://api.gdsinsing.com/safety/api/remove-identifier-attr

請求方法

POST

接口參數

參數名稱	參數類型	參數說明
account	string	企業賬號(標識前綴)
jsonData	string	`{ handle: 標識號, index: [1,2,3] }`
sign	string	`{ timestamp: 時間戳(可為空), sign:（jsonData+timestamp）取哈希值(sha256)，然后進行數字(SM9)簽名 }`

成功返回

參數名稱	參數類型	參數說明
result	int	1:成功，0:失敗

失敗返回

參數名稱	參數類型	參數說明
result	int	0
errorcode	string	錯誤碼
msg	string	異常描述
solve	string	解決辦法

SDK API接口

假如您對網絡協議和數據加密技術不太熟悉，我們為您提供了SDK API接口。SDK接口將會為您屏蔽掉網絡發送過程和數據加密過程，您只需要調用我們SDK中的接口方法，就能輕松地對標識進行管理和應用系統開發。

創建標識接口

接口名稱

創建標識

接口方法

public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception

接口參數

參數名稱	參數類型	參數說明
handleName	String	標識前綴
handleId	String	標識自定義碼
datatemplate	String	數據模板編號
viewtemplate	String	展示模板編號(可為空)
datas	List	標識關聯數據

返回值

標識碼

通用創建標識接口

接口名稱

通用創建標識

接口方法

public String createIdentifier(String handleName, String handleId, String datatemplate, String viewtemplate, List datas) throws Exception

接口參數

參數名稱	參數類型	參數說明
handleName	String	標識前綴
handleId	String	標識自定義碼
datatemplate	String	數據模板編號
viewtemplate	String	展示模板編號(可為空)
datas	List<RelateData>	標識關聯數據

返回值

標識碼

標識解析接口

接口名稱

標識解析

接口方法

public List<RelateData> queryIdentifier(String handle) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼

返回值

標識關聯信息

標識解析接口

接口名稱

標識解析

接口方法

public List<RelateData> queryIdentifier(String handle, int[] indexs, String[] types) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼
indexs	int[]	關聯信息索引(可為null)
types	String[]	關聯信息類型(可為null)

返回值

標識關聯信息

刪除標識接口

接口名稱

刪除標識

接口方法

public void removeIdentifier(String handle) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼

返回值

添加標識關聯屬性接口

接口名稱

添加標識關聯屬性

接口方法

public void addIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼
infos	List<RelateInfo>	標識關聯信息

返回值

修改標識關聯屬性接口

接口名稱

修改標識關聯屬性

接口方法

public void modifyIdentifierAttr(String handle, List<RelateInfo> infos) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼
infos	List<RelateInfo>	標識關聯信息

返回值

刪除標識關聯屬性接口

接口名稱

刪除標識關聯屬性

接口方法

public void removeIdentifierAttr(String handle, int[] indexs) throws Exception

接口參數

參數名稱	參數類型	參數說明
handle	String	標識碼
indexs	int[]	關聯信息索引(可為null)

返回值

API介紹

簡介

HTTP API接口

創建標識接口

通用創建標識接口

標識解析接口

刪除標識接口

添加標識關聯信息接口

修改標識關聯信息接口

刪除標識關聯信息接口

SDK API接口

創建標識接口

通用創建標識接口

標識解析接口

標識解析接口

刪除標識接口

添加標識關聯屬性接口

修改標識關聯屬性接口

刪除標識關聯屬性接口