Appearance
海政通信创SDK迁移方案
SDK说明
- 旧版海政通SDK为包引入模式,包名为 gdt-jsapi,调用命名空间为dd.XXX
- 旧版uaa授权登录为包引入模式。包名为 @szhn/uaa-sdk-bridge,调用命名空间为window.SZHN_UAA_JS_BRIDGE.XXX
- 新版SDK为cdn引入模式,包名为 https://app-ding.digitalhainan.com.cn:10336/js/szhn-hzt-sdk-release-1.0.0.min.js,调用命名空间为 window.SZHN_HZT_SDK.XXX。
注意:新版SDK是同时兼容旧版海政通SDK和旧版本uaa授权登录所有逻辑,所以使用了新版本SDK则可以把旧版海政通SDK和旧版uaa授权登录包删除,统一使用新版本SDK。这里需要把gdt-jsapi和@szhn/uaa-sdk-bridge的包以及对应的引入逻辑删除,然后把以下命名空间做一下替换:
旧版uaa授权登录替换新版SDK
javascript
window.SZHN_UAA_JS_BRIDGE.init()
// 替换成
window.SZHN_HZT_SDK.init()
旧版海政通SDK替换新版SDK
javascript
// 旧的SDK
dd.getWaterMark()
// 替换成新的SDK
window.SZHN_HZT_SDK.getWaterMark()
新旧版本替换只涉及到包和命名空间的调整,具体的调用方法(入参、出参等)新旧版本是结果是一样的。
使用步骤
第一步:引入信创SDK
html
<script src="https://app-ding.digitalhainan.com.cn:10336/js/szhn-hzt-sdk-release-1.0.0.min.js"></script>
第二步:使用信创SDK
javascript
window.SZHN_HZT_SDK.XXX() // XXX为具体的调用方法。
//比如使用获取水印方法
window.SZHN_HZT_SDK.getWaterMark().then((res) => {
// code success 成功 逻辑处理
}).catch((err)=>{
// code error 失败逻辑处理
})
如果原来使用了dd.XXX调用海政通底座方法,需要将 dd.XXX替换成window.SZHN_HZT_SDK.XXX,比如调用水印方法:
javascript
// 旧版本dd.xxx方法
dd.getWaterMark().then((res) => {
// code success 成功 逻辑处理
}).catch((err)=>{
// code error 失败逻辑处理
})
//新版信创海政通方法
window.SZHN_HZT_SDK.getWaterMark().then((res) => {
// code success 成功 逻辑处理
}).catch((err)=>{
// code error 失败逻辑处理
})
第三步:实现登录授权
因为新版SDK已兼容旧版本UAA-SDK,所以可以通过替换老的UAA-SDK成新版SDK。
初始化SDK
javascript
// 旧版本UAA-SDK
window.SZHN_UAA_JS_BRIDGE.init()
// 新版SZHN_HZT_SDK,具体入参请查阅对应API的文档
window.SZHN_HZT_SDK.init()
获取授权token
javascript
// 旧版本UAA-SDK
window.SZHN_UAA_JS_BRIDGE.login().then((res) => {
// code success 成功 逻辑处理
}).catch((err)=>{
// code error 失败逻辑处理
})
// 新版SZHN_HZT_SDK,具体入参请查阅对应API的文档
window.SZHN_HZT_SDK.getUaaAuthToken().then((res) => {
// code success 成功 逻辑处理
}).catch((err)=>{
// code error 失败逻辑处理
})