文档中心

快速入门

一分钟了解 XMagital 平台

开始制作您的第一个应用

应用的联调与自测

成为进阶开发者

解决方案

应用认证发布

标准规范

接口文档

应用开发示例

应用开发脚手架

工程环境服务接口

版本记录

版本号	日期	修改内容
v0.12.2	2024-08-30	修复已知问题

ENG

其他服务推送消息

接口地址

/hsm-eng/v1/msg/send

请求方式

POST

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

工具服务推送消息到 ENG 前端信息栏

请求参数

参数名称	请求类型	是否必须	数据类型
dataList[0].content	query	true	string
dataList[0].level	query	true	integer(int32)
dataList[0].serverName	query	true	string
dataList[0].type	query	true	string
from	query	true	string
socketId	query	true	string
target	query	true	string
type	query	true	string
dataList[0].jumpMenu	query	false	boolean
dataList[0].menuData	query	false	string
dataList[0].show	query	false	boolean
dataList[0].timeStamp	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ResultWrapper«Void»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

发布消息

接口地址

/hsm-eng/v1/pub/{topic}

请求方式

POST

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

向指定 Topic 发布消息

请求示例

{
  "payload": "",
  "topic": ""
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
topic	topic	path	true	string
pubReq	PubReq	body	true	PubReq	PubReq
payload			false	string
topic			false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«string»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

示例

{
	"code": 0,
	"data": "",
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

订阅 Topic

接口地址

/hsm-eng/v1/sub

请求方式

POST

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

订阅指定 Topic 以接收 Topic 发布的消息

请求示例

{
  "appId": "",
  "appName": "",
  "topic": "",
  "webhook": {
    "callBackType": "",
    "headers": "",
    "maxRetryTimes": 0,
    "method": "",
    "params": "",
    "timeout": 0,
    "url": ""
  }
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
subReq	SubReq	body	true	SubReq	SubReq
appId			false	string
appName			false	string
topic			false	string
webhook			true	WebHookReq	WebHookReq
callBackType			false	string
headers			false	string
maxRetryTimes			false	integer
method			false	string
params			false	string
timeout			false	integer
url			false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	object
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

示例

{
	"code": 0,
	"data": {},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

删除订阅

接口地址

/hsm-eng/v1/sub

请求方式

DELETE

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

工具服务不再订阅该 Topic

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appId	appId	query	true	string
topic	topic	query	true	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«object»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	object
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

示例

{
	"code": 0,
	"data": {},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

注册数据

接口地址

/hsm-eng/v1/dc

请求方式

POST

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

将数据注册到 ENG 中，供其它服务使用

请求示例

{
  "lang": "",
  "name": "",
  "projectId": "",
  "userId": "",
  "value": ""
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
registerDataReq	RegisterDataReq	body	true	RegisterDataReq	RegisterDataReq
lang	语言		false	string
name	数据名称		false	string
projectId	项目 id		false	string
userId	用户 id		false	string
value	数据		false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«JSONObject»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	object
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": {},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

更新数据

接口地址

/hsm-eng/v1/dc/{id}

请求方式

PUT

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

更新注册到 ENG 的数据

请求示例

{
  "lang": "",
  "name": "",
  "projectId": "",
  "userId": "",
  "value": ""
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	string
registerDataReq	RegisterDataReq	body	true	RegisterDataReq	RegisterDataReq
lang	语言		false	string
name	数据名称		false	string
projectId	项目 id		false	string
userId	用户 id		false	string
value	数据		false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«JSONObject»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	object
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": {},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

删除数据

接口地址

/hsm-eng/v1/dc/{id}

请求方式

DELETE

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

删除已经注册到 ENG 的数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«string»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": "",
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

查询数据

接口地址

/hsm-eng/v1/dc/{name}

请求方式

GET

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

查询已经注册到 ENG 的指定 name 的数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
name	name	path	true	string
projectId	projectId	query	false	string
userId	userId	query	false	string
lang	lang	query	false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«RegisterDataResp»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	RegisterDataResp	RegisterDataResp
createTime	创建时间	string(date-time)
dataId	数据 id	string
lang	语言	string
name	数据名称	string
projectId	项目 id	string
updateTime	更新时间	string(date-time)
userId	用户 id	string
value	数据	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

示例如下

{
	"code": 0,
	"data": {
		"createTime": "",
		"dataId": "",
		"lang": "",
		"name": "",
		"projectId": "",
		"updateTime": "",
		"userId": "",
		"value": ""
	},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

批量接口注册

接口地址

/hsm-eng/v1/batchIc

请求方式

POST

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

批量将接口注册到 ENG，供 ENG 调用

请求示例

{
  "interfaceList": [
    {
      "appId": "",
      "headers": "",
      "interfaceId": "",
      "ip": "",
      "key": "",
      "method": "",
      "name": "",
      "params": "",
      "port": "",
      "timeout": 0,
      "url": "",
      "version": ""
    }
  ]
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
batchInterfaceReq	BatchInterfaceReq	body	true	BatchInterfaceReq	BatchInterfaceReq
interfaceList			false	array	InterfaceReq
appId			false	string
headers			false	string
interfaceId			false	string
ip			false	string
key			false	string
method			false	string
name			false	string
params			false	string
port			false	string
timeout			false	integer
url			false	string
version			false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«List«string»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	array
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": [],
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

单个接口注册

接口地址

/hsm-eng/v1/ic

请求方式

POST

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

将单个接口注册到 ENG 中，供 ENG 使用

请求示例

{
  "appId": "",
  "headers": "",
  "interfaceId": "",
  "ip": "",
  "key": "",
  "method": "",
  "name": "",
  "params": "",
  "port": "",
  "timeout": 0,
  "url": "",
  "version": ""
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
interfaceReq	InterfaceReq	body	true	InterfaceReq	InterfaceReq
appId			false	string
headers			false	string
interfaceId			false	string
ip			false	string
key			false	string
method			false	string
name			false	string
params			false	string
port			false	string
timeout			false	integer(int32)
url			false	string
version			false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«JSONObject»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	object
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": {},
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

接口查询

接口地址

/hsm-eng/v1/ic/{name}

请求方式

GET

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

查询注册到 ENG 服务的指定 name 的接口信息

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
name	name	path	true	string
appId	appId	query	false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«List«InterfaceReq»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	array	InterfaceReq
appId		string
headers		string
interfaceId		string
ip		string
key		string
method		string
name		string
params		string
port		string
timeout		integer(int32)
url		string
version		string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

示例如下

{
	"code": 0,
	"data": [
		{
			"appId": "",
			"headers": "",
			"interfaceId": "",
			"ip": "",
			"key": "",
			"method": "",
			"name": "",
			"params": "",
			"port": "",
			"timeout": 0,
			"url": "",
			"version": ""
		}
	],
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

接口删除

接口地址

/hsm-eng/v1/{appId}

请求方式

DELETE

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

删除注册到 ENG 的接口数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appId	appId	path	true	string
id	id	path	true	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«string»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": "",
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

接口修改

接口地址

/hsm-eng/v1/{appId}/{id}

请求方式

PUT

请求数据类型

application/x-www-form-urlencoded,application/json

响应数据类型

*/*

接口描述

修改已经注册到 ENG 的接口数据

请求示例

{
  "appId": "",
  "headers": "",
  "interfaceId": "",
  "ip": "",
  "key": "",
  "method": "",
  "name": "",
  "params": "",
  "port": "",
  "timeout": 0,
  "url": "",
  "version": ""
}

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appId	appId	path	true	string
id	id	path	true	string
interfaceReq	InterfaceReq	body	true	InterfaceReq	InterfaceReq
appId			false	string
headers			false	string
interfaceId			false	string
ip			false	string
key			false	string
method			false	string
name			false	string
params			false	string
port			false	string
timeout			false	integer(int32)
url			false	string
version			false	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«string»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": "",
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}

接口删除

接口地址

/hsm-eng/v1/{appId}/{id}

请求方式

DELETE

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

接口描述

删除已经注册到 ENG 的接口数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appId	appId	path	true	string
id	id	path	true	string

响应状态

状态码	说明	schema
200	OK	ResultWrapper«string»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	响应码	integer(int32)	integer(int32)
data	数据内容	string
errors	错误响应信息	array	Error
code		integer(int32)
message		string
name		string
object		object
timestamp		string
message	响应信息	string
pageNum	当前页	integer(int32)	integer(int32)
pageSize	行数	integer(int32)	integer(int32)
pageTotal	总页数	integer(int32)	integer(int32)
timestamp	业务自行确定	object
total	总条数	integer(int32)	integer(int32)

响应示例

{
	"code": 0,
	"data": "",
	"errors": [
		{
			"code": 0,
			"message": "",
			"name": "",
			"object": {},
			"timestamp": ""
		}
	],
	"message": "",
	"pageNum": 0,
	"pageSize": 0,
	"pageTotal": 0,
	"timestamp": {},
	"total": 0
}