初始化SDK

更新时间:2024-12-23 10:57:22

接口描述

初始化SDK,初始化信息包含有:应用配置、与服务端通讯的http配置、与服务端通讯的签名安全策略配置。

开发者在对接过程中,需注意:

1、全局初始化成功后,Manager会存储初始化结果,无需重复初始化。

2、如果已在沙箱环境中完成过初始化,现在需要在正式环境初始化,则需要重启Web容器(如Tomcat)后再用正式环境参数进行初始化,否则会造成无法成功切换到正式环境。(通过 itsmApiUrl 初始化地址进行环境切换)

接口地址

http://ip:port/paas-sdk-service/timevale/init

请求方式

POST

请求数据格式

application/json; charset=UTF-8

itsmApiUrl 初始化地址列表

环境

apisUrl 初始化地址

公网IP

端口

正式生产环境

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://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

请求参数

展开全部参数参数名称

类型

必选

参数说明

projectConfig(点击“+”展开详情)

object

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

projectId

string

应用ID

projectSecret

string

应用Secret

itsmApiUrl

string

初始化地址(详见上方 itsmApisUrl 初始化地址列表

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

算法类型,默认值 HMAC-SHA256

响应参数

参数名称

类型

必选

参数说明

errCode

int

错误码

msg

string

错误信息

errShow

boolean

错误信息是否显示

请求示例  

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

POST http://localhost:8080/paas-sdk-service/timevale/init

{
	"projectConfig":
	{
		"projectId":"您的应用ID",
		"projectSecret":"您的应用secret",
		"itsmApiUrl":"http://smlitsm.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2"
	},
	"httpConfig":
	{
		"proxyIp":"",
		"proxyPort":"",
		"retry":"5",
		"httpType":"HTTP"
	},
	"signConfig":
	{
		"algorithm":"HMACSHA256"
	}
}

响应示例

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


我要纠错