注册客户端

更新时间:2024-12-23 10:48:41

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

接口描述

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

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

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

2、如果已在沙箱环境中完成过注册客户端,现在需要在正式环境注册客户端,则需要重启Web容器(如Tomcat)后再用正式环境注册客户端,否则会造成无法成功切换到正式环境。

接口名称

 ServiceClientManager.registClient( ProjectConfig projectConfig, HttpConnectionConfig httpConnectConfig,

 SignatureConfig signatureConfig )

apisUrl请求地址

环境

请求地址

公网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。

请求参数

展开全部参数参数名称

类型

必选

长度

参数说明

projectConfig

ProjectConfig


项目配置,从开放平台获取


projectId

String

80

项目编号

projectSecret

String

100

项目密钥

apisUrl

String

100

开放平台地址

httpConnectConfig

HttpConnectionConfig


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

httpType

HttpType


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

枚举:

(1)HTTPS

(2)HTTP

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

retry

Integer


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

timeoutConnect

Integer


SDK与e签宝服务器建立连接的超时时间。

单位:秒

最大值不能超过30秒

timeoutRequest

Integer


从SDK发送请求到e签宝服务器返回响应整个请求过程的超时时间。

单位:秒

最大值不能超过30秒

proxyIp

String

80

正向代理服务IP地址

proxyPort

Integer


正向代理服务端口

username

String


正向代理服务器用户名

password

String


正向代理服务器用户密码

signatureConfig

SignatureConfig


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


algorithm

AlgorithmType


算法类型,默认HMAC-SHA256

(1)HMAC-SHA256

响应参数

展开全部参数参数名称

类型

必选

参数说明

Result

Result

响应结果


errCode

int

错误码,0标识成功,其他均标识失败

msg

String

错误信息,错误码对应的说明信息

errorShow

boolean

错误信息是否建议显示

请求示例  

static Result rst = ServiceClientManager.registClient(getProjectCfg(), getHttpConCfg(), getSignatureCfg());

	public static void main(String[] args) {
		// 注册客户端结果
		if (rst.getErrCode() != 0)
			System.out.println("注册客户端失败:" + rst.getMsg());
		else
			System.out.println("注册客户端成功");

	}

	/**
	 *
	 * description 进行项目配置,如果是测试环境,请联系E签宝交付顾问获取
	 */
	public static ProjectConfig getProjectCfg() {
		ProjectConfig proCfg = new ProjectConfig();
		// 项目ID(应用ID)
		proCfg.setProjectId("4438xxxxx09");
		// 项目Secret(应用Secret)
		proCfg.setProjectSecret("756b644b4xxxxxxxxxxx361e07cc24");
		// 开放平台地址
		// 需要添加ip白名单,而且添加之后需要等五分钟之后才能生效,否则会报错:接口调用方尚未配置ip白名单,请联系e签宝管理员配置
		// 正式环境请求地址:http://openapi.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2
		// 测试环境请求地址:http://smlitsm.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2
		proCfg.setItsmApiUrl("http://smlitsm.tsign.cn:8080/tgmonitor/rest/app!getAPIInfo2");
		return proCfg;
	}

	/**
	 *
	 * description http配置
	 */
	private static HttpConnectionConfig getHttpConCfg() {
		HttpConnectionConfig httpConCfg = new HttpConnectionConfig();
		// 代理服务IP配置
		httpConCfg.setProxyIp(null);
		// 代理服务端口
		httpConCfg.setProxyPort(null);
		// 协议类型,默认Https
		httpConCfg.setHttpType(HttpType.HTTPS);
		// 请求失败重试次数,默认5次
		httpConCfg.setRetry(null);
		//连接超时时间配置,最大不能超过30秒
		httpConCfg.setTimeoutConnect(30);
		// 请求超时时间,最大不能超过30
		httpConCfg.setTimeoutRequest(30);
		// 代理服务器登录用户名
		httpConCfg.setUsername(null);
		// 代理服务器登录密码
		httpConCfg.setPassword(null);
		return httpConCfg;
	}

	/**
	 * description 签名配置
	 */
	private static SignatureConfig getSignatureCfg() {
		SignatureConfig signCfg = new SignatureConfig();
		signCfg.setAlgorithm(AlgorithmType.HMACSHA256);

		// 若算法类型是RSA,需要设置e签宝公钥和平台私钥
		/*signCfg.setEsignPublicKey(null);
		signCfg.setPrivateKey(null);*/

		return signCfg;
	}

响应示例

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

错误码

错误码

错误描述

解决方案

200201

请求签名必填


801009

projectId参数为空


801009

projectSecret参数为空


1000011

外部服务错误:2, 根据项目id找不到项目,可能项目已经被删除


801009

itsmApiUrl参数为空



我要纠错