天谷客户端服务使用帮助

服务信息

服务器地址：http://localhost:7688/

注意事项：1、只允许本地或指定IP访问，其他IP地址禁止访问。
2、服务程序为单线程，需等待请求成功后再执行下一个请求，否则会导致响应较慢等问题。

1、ActiveX插件服务

插件服务地址：http://localhost:7688/TGCtrlApi

请求类型：POST

1.1、插件初始化

参数说明：{"serverName":"ActiveX插件CLSID。"}

TGCertMgrCtrl示例： {"serverName":"{0DADE507-64D6-4306-956A-2ED144FF0ED1}"}

1.2、初始化返回值

1.2.1、JSON格式返回结果说明:
{ "errorCode": 客户端服务错误码(0-成功，其他错误),
"errorMsg": "错误码对应信息详细描述。",
"result": "插件初始化结果信息,成功时有效,详见1.2.2。",
"serverName": "服务名称:请求初始化的ActiveX插件CLSID。" }

1.2.2、初始化result说明:
{"funcList": [ //接口列表;
{
"funcName": "接口名称",
"funcType": "接口类型，如:Method",
"paramList": [
{ //参数列表;
"paramName": "参数名称",
"paramType": "参数数据类型，如：VT_BSTR、VT_I4等"
}]}]}

注意事项：初始化返回的是实际调用的接口和参数， 如果和插件接口文档描述不符，请联系该工具提供人员解决。

1.3、插件接口调用

参数说明：{"serverName":"{ActiveX插件CLSID。}", "funcName":"接口名称","param":"{\"参数名称\":\"参数内容\"}"}

TGCertMgrCtrl示例： {"serverName":"{0DADE507-64D6-4306-956A-2ED144FF0ED1}","funcName":"selectCert","param":"{\"filterCondition\":\"\"}"}

注意事项：接口参数如有需要转义字符，需注意转义层级。

1.4、接口调用返回值

JSON格式返回结果说明:
{ "errorCode": 客户端服务错误码(0-成功，其他错误),
"errorMsg": "错误码对应信息详细描述。",
"result": "插件接口实际返回值，详情参考对应插件接口文档。",
"serverName": "服务名称:请求初始化的ActiveX插件CLSID。",
"funcName":"插件接口名称" }

示例：可参考本网页“加载插件”功能。

2、第三方服务接口转发服务

转发服务地址：http://localhost:7688/TGServerForward

请求类型：POST

2.1、第三方服务调用说明

JSON格式参数说明:
{ "funcType": "请求类型，仅支持：POST，GET, PUT，其他参数无效，默认使用POST。",
"funcName": "第三方服务接口URL",
"param": "请求参数",
"header": "请求头信息（JSON）,示例：{"httpHead":["headItem1: XXX","headItem2: XXX"]}",
"contentType": "参数类型，仅支持：text/html，text/plain，text/xml， image/gif，image/jpeg，image/png，application/xml， application/json，application/octet-stream，multipart/form-data， 其他参数无效，默认使用NONE"
}

2.2、返回值

JSON格式返回结果说明:
{ "errorCode": 客户端服务错误码(0-成功，其他错误),
"errorMsg": "错误码对应信息详细描述。",
"result": "第三方服务接口实际返回值，详情参考对应接口说明。",
"responseHeader": "第三方服务响应头信息。",
"funcName":"第三方服务接口信息。" }

示例：可参考本网页“服务转发”功能。

注意事项：只可转发API形式服务接口，其他方式URL暂不支持。

3、WEB服务

WEB目录：应用程序相同目录，web文件夹。

注意事项：TG开头（不区分大小写），无后缀名路径， 为客户端自定义服务保留路径， 不建议WEB服务使用，可能会被覆盖，影响正常使用。