项目初始化

更新时间:2024-12-23 10:59:56

重要提醒:自2021年8月1日起,未经我司同意新客户不允许对接此产品。

接口描述

初始化SDK,初始化信息包含有:项目配置、与服务端通讯的http配置、与服务端通讯的签名安全策略配置。初始化成功后,SDK会存储初始化结果,无需重复初始化。

开发者需注意:

如果已在模拟环境中完成过项目初始化,现在需要在正式环境进行项目初始化,则需要重启Web容器(如Tomcat或一键部署包techWrapper)之后再用正式环境信息进行项目初始化,否则会造成无法成功切换到正式环境。

接口

http://ip:port/tech-sdkwrapper/timevale/init

请求方式

POST

请求参数

展开全部参数参数名称

类型

必选

参数说明

projectConfig

object

应用配置,从开放平台获取


projectId

string

项目编号

projectSecret

string

项目密钥

itsmApiUrl

string

开放平台地址,具体参数值详见下方itsmApiUrl请求地址信息

httpConfig

object

Http配置,与服务端通讯的http配置

httpType

string

SDK中请求e签宝服务端采用的协议类型,默认HTTPS

枚举:

(1)HTTPS

(2)HTTP

若需要SDK中请求e签宝服务端接口的URL使用https,此参数请填写HTTPS

retry

int

请求失败重试次数,默认5

proxyIp

string

正向代理服务IP地址

proxyPort

int

正向代理服务端口

signConfig

object

签名配置,与服务端通讯的签名安全策略配置


algorithm

string

算法类型(HMACSHA256)

itsmApiUrl请求地址信息

环境

请求地址

公网IP

端口

正式生产环境

(旧网关)

http://openapi.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2

101.37.189.192

8080

https://openapi.tsign.cn:443/tgmonitor/rest/app!getAPIInfo2

101.37.189.192

443

正式生产环境

(新网关)

http://sdkapi.esign.cn/tgmonitor/rest/app!getAPIInfo2

116.62.8.203

80

https://sdkapi.esign.cn/tgmonitor/rest/app!getAPIInfo2

116.62.8.203

443

正式生产环境

(新对接停用

http://itsm.tsign.cn/tgmonitor/rest/app!getAPIInfo2

101.37.189.192

8080

https://itsm.tsign.cn/tgmonitor/rest/app!getAPIInfo2

101.37.189.192

443

沙箱模拟环境

http://smlitsm.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2

114.55.17.44

8080

https://smlitsm.tsign.cn:8083/tgmonitor/rest/app!getAPIInfo2

114.55.17.44

8083

说明:

正式环境 openapi.tsign.cn 和 sdkapi.esign.cn 二选一即可。

正式环境 itsm.tsign.cn 是保留给老客户使用,自2020年开始新对接的客户请不要再使用itsm.tsign.cn。

响应参数

参数名称

类型

必选

参数说明

示例值

errCode

int

错误码


msg

string

错误信息


errShow

boolean

错误信息是否显示


请求示例  

请求参数示例:具体根据实际业务场景进行传参,此处仅为参考

POST http://localhost:8080/tech-sdkwrapper/timevale/init
localhost:8080这里参考https://qianxiaoxia.yuque.com/docs/share/7c96dfbc-1e53-4de3-b1f6-46e10eda67b4

{
	"projectConfig":
	{
		"projectId":"项目id",
		"projectSecret":"密钥",
		"itsmApiUrl":"http://smlitsm.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2"
	},
	"httpConfig":
	{
		"proxyIp":"",
		"proxyPort":"",
		"retry":"5",
		"httpType":"HTTP"
	},
	"signConfig":
	{
		"algorithm":"HMACSHA256",
		"privateKey":"",
		"esignPublicKey":""
	}
}

响应示例

{
    "msg": "成功",
    "errCode": 0,
    "errShow": false
}

错误码

错误码

错误描述

解决方案


我要纠错