API接口 · 京麦网页JSSDK文档 |
您所在的位置：网站首页 › 京麦网页如何登录 › API接口 · 京麦网页JSSDK文档 |
|
京麦JSSDK PC版 2.x版本1. 安装1.1. script 引入2. API2.1. config(options: object) 初始化设置2.2. isInJMPC() 判定是否在京麦windows客户端中2.3. isInJMMac() 判定是否在京麦mac客户端中2.4. isInJM 判定是否在京麦客户端中（windows或mac）2.5. getVersion() 获取京麦客户端的版本2.6. checkJMClient(options: object) 判定是否安装了京麦客户端2.7. openJM(options: object) 打开京麦客户端2.8. openUrl(options: object) 在京麦客户端中打开链接2.9. openDD(options: object) 打开咚咚2.10. openPlugin(options: object)打开插件2.11. updatePlugin() 刷新插件列表2.12. openService(options: object) 直接通过客户端打开插件2.13. checkApi(options: object) 判定当前的客户端是否支持了该API2.14. openNativePage(pageName: string) 打开原生页面2.15. checkBookmarked(options: object) 判定当前网址是否已收藏2.16. checkFrequentPlugin(options: object) 判定当前插件是否已添加到常用插件中2.17. addToBookmark() 将当前网址添加到收藏中2.18. addToFrequentPlugin() 将当前插件添加到我的常用插件中2.19. checkVersion(options: object) 判定当前客户端是否为最新版本2.20. upgradeClient(options: object) 更新客户端2.21. captureScreen(options: object) 客户端截图功能2.22. request(options: object) 互通协议3. Error 类型 京麦JSSDK PC版 2.x版本
1. 安装
1.1. script 引入
在html页面中引入下面该地址： jmsdkPC.isInJMPC() 2. API 2.1. config(options: object) 初始化设置目前options中只有1个languange属性，如果不需要切换语言，则无需调用。 options 参数: 参数 说明 类型 可选值 默认值 是否必填 language 设置语言 string 'en_US' 'zh_CN' — jmsdkPC.config({ language: 'en_US' }) 2.2. isInJMPC() 判定是否在京麦windows客户端中 jmsdkPC.isInJMPC() 2.3. isInJMMac() 判定是否在京麦mac客户端中 jmsdkPC.isInJMMac() 2.4. isInJM 判定是否在京麦客户端中（windows或mac） jmsdkPC.isInJM() 2.5. getVersion() 获取京麦客户端的版本 jmsdkPC.getVersion() // 7.9.6 2.6. checkJMClient(options: object) 判定是否安装了京麦客户端options 参数: 参数 说明 类型 可选值 默认值 是否必填 success 成功回调 function — — 否success 回调参数： 参数 options (object)： 参数 说明 类型 isInstall 是否安装了京麦 boolean支持 Promise jmsdkPC.checkJMClient({ success: function (res) { console.log(res.isInstall) } }) // promise jmsdkPC.checkJMClient().then(res => { console.log(res.isInstall) }) 2.7. openJM(options: object) 打开京麦客户端options 参数: 参数 说明 类型 可选值 默认值 是否必填 pin 用户pin，用于打开登录了该用户的客户端实例，如果不传，则每次都是打开新的客户端登录窗口 string — — 否options 参数可以不传。 该接口为异步接口，无回调函数。 如果没有安装客户端，则会弹窗提示安装客户端（mac版不会提示，如果打开失败，则无任何反应）。 jmsdkPC.openJM() 2.8. openUrl(options: object) 在京麦客户端中打开链接1）在客户端外部，唤起客户端，并打开链接 2）在客户端内部，直接打开链接 3）在mac系统下的非京麦浏览器或者移动端，直接跳转地址 options 参数: 参数 说明 类型 可选值 默认值 是否必填 pin 用户pin，用于在第1）种情况下打开登录了该用户的客户端实例，如果不传，则每次都是打开新的客户端登录窗口 string — — 否 url 链接地址 string — — 是 jmsdkPC.openUrl({ pin: 'test_pop_7191', url: 'https://jm.jd.com' }) 2.9. openDD(options: object) 打开咚咚1）在客户端外部，唤起客户端，并打开咚咚 2）在客户端内部，打开咚咚 options 参数: 参数 说明 类型 可选值 默认值 是否必填 pin 用户pin，用于在第1）种情况下打开登录了该用户的客户端实例，如果不传，则每次都是打开新的客户端登录窗口 string — — 否 client 目标用户的pin，打开目标用户的会话窗口，如果不传，则只启动咚咚，不会打开会话 string — — 否 jmsdkPC.openDD({ pin: 'test_pop_7191', client: 'test_pop_weidian' }) 2.10. openPlugin(options: object)打开插件1）服务市场插件，不启动客户端 2）京麦插件，且没有设置成普通浏览器打开的白名单，使用京麦打开 3）咚咚插件，使用京麦打开 4）移动端插件，在中间页中无任何操作 5）开普勒小程序，不启动客户端 options 参数： 参数 说明 类型 可选值 默认值 是否必填 pin 用户pin，用于打开登录了该用户的客户端实例，如果不传，则每次都是打开新的客户端登录窗口 string — — 否 serviceCode 插件标识 string — — 是 itemCode 插件类型，一般在服务市场列表中使用 string — — 否 protocolId 用于京麦插件打开指定插件页面 string — — 否 keplerAppId 开普勒小程序Id，用于开普勒小程序 string — — 否 update 是否刷新客户端的插件列表 boolean — — 否update: 是否刷新插件列表，只在客户端中调用才有效，用于用户新购买了插件，但客户端中的插件列表尚未更新，需要刷新一次才可以打开客户端。 jmsdkPC.openPlugin({ pin: 'test_pop_7191', serviceCode: 'FW_GOODS-549810' }) 2.11. updatePlugin() 刷新插件列表客户端可用，非客户端无效 jmsdkPC.updatePlugin() 2.12. openService(options: object) 直接通过客户端打开插件openPlugin 中大部分插件不会通过客户端打开，有中间页，体验较差，这个接口用于直接在客户端打开插件，避免被浏览器拦截窗口，目前用于大促页中的插件，大促页中需要先进行零元购，然后再启动客户端，如果用 openPlugin ，因为窗口被拦截，所以无法走完这一流程。 不支持开普勒小程序。 options 参数： 参数 说明 类型 可选值 默认值 是否必填 pin 用户pin，用于打开登录了该用户的客户端实例，如果不传，则每次都是打开新的客户端登录窗口 string — — 否 serviceCode 插件标识 string — — 是 protocolId 用于京麦插件打开指定插件页面 string — — 否 update 是否刷新客户端的插件列表 boolean — — 否 jmsdkPC.openService({ pin: 'test_pop_7191', serviceCode: 'FW_GOODS-549810' }) 2.13. checkApi(options: object) 判定当前的客户端是否支持了该API客户端可用，非客户端无效； 目前所有客户端的API都已支持，暂时不需要调用该接口，一般用于新API出来时客户端版本还未覆盖全面，但想立即使用该API接口时调用进行判定。 options 参数： 参数 说明 类型 可选值 默认值 是否必填 api api 名称（函数名） string — — 是 success 成功回调 function — — 否 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否success 回调参数： 参数 res (object) 参数 说明 类型 isSupport 是否支持API boolean支持 Promise 回调 jmsdkPC.checkApi({ api: 'addToBookmark', success: function (res) { console.log(res) }, error: function (error) { console.log(error.message) } }) // promise 回调 jmsdkPC.checkApi({ api: 'addToBookmark' }).then(res => { console.log(res) }).catch(error => { console.log(error.message) }) 2.14. openNativePage(pageName: string) 打开原生页面客户端可用，非客户端无效 jmsdkPC.openNativePage('MyPlugin')pageName 支持的页面： 页面标识 页面名称 'MyPlugin' 我的插件 'Message' 消息中心 2.15. checkBookmarked(options: object) 判定当前网址是否已收藏客户端可用，非客户端无效 options 参数： 参数 说明 类型 可选值 默认值 是否必填 success 成功回调 function — — 是 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否success 回调参数： 参数 res (object) 参数 说明 类型 isBookmarked 是否已收藏 boolean支持 Promise 回调 jmsdkPC.checkBookmarked({ success: function (res) { console.log(res.isBookmarked) } }) // promise 回调 jmsdkPC.checkBookmarked().then(res => { console.log(res.isBookmarked) }) 2.16. checkFrequentPlugin(options: object) 判定当前插件是否已添加到常用插件中客户端可用，非客户端无效 options 参数： 参数 说明 类型 可选值 默认值 是否必填 success 成功回调 function — — 是 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否success 回调参数： 参数 res (object) 参数 说明 类型 isFrequentPlugin 是否已是常用插件 boolean支持 Promise 回调 jmsdkPC.checkFrequentPlugin({ success: function (res) { console.log(res.isFrequentPlugin) } }) // promise 回调 jmsdkPC.checkFrequentPlugin().then(res => { console.log(res.isFrequentPlugin) }) 2.17. addToBookmark() 将当前网址添加到收藏中客户端可用，非客户端无效 jmsdkPC.addToBookmark() 2.18. addToFrequentPlugin() 将当前插件添加到我的常用插件中客户端可用，非客户端无效 jmsdkPC.addToFrequentPlugin() 2.19. checkVersion(options: object) 判定当前客户端是否为最新版本客户端可用，非客户端无效 options 参数： 参数 说明 类型 可选值 默认值 是否必填 success 成功回调 function — — 是 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否success 回调参数： 参数 res (object): 参数 说明 类型 isLastest 是否是最新版本客户端 boolean支持 Promise 回调 jmsdkPC.checkVersion({ success: function (res) { console.log(res.isLastest) } }) // promise 回调 jmsdkPC.checkVersion().then(res => { console.log(res.isLastest) }) 2.20. upgradeClient(options: object) 更新客户端options 参数： 参数 说明 类型 可选值 默认值 是否必填 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否支持 Promise 回调 jmsdkPC.upgradeClient() // promise jmsdkPC.upgradeClient().catch(error => { console.log(error.message) }) 2.21. captureScreen(options: object) 客户端截图功能客户端可用，非客户端无效，版本：7.9.9 options 参数： 参数 说明 类型 可选值 默认值 是否必填 type 图片类型 string 'png', 'jpg', 'jpeg' 'png' 否 success 成功回调 function — — 否 error 失败回调，当客户端不支持或者在外部浏览器调用时触发，回调参数：Error实例 function — — 否success 回调参数： 参数 res (object) 参数 说明 类型 code 0 - 截图完成，1 - 截图取消 number urlData 截图的base64编码 string blob 将base64格式的图片转换成Blob对象，方便通过Ajax进行上传，IE9及以下不支持 Blob fileSize 图片大小，单位：byte number支持 Promise jmsdkPC.captureScreen({ success: function (res) { console.log(res.urlData，res.blob) } }) // promise jmsdkPC.captureScreen().then(res => { console.log(res.urlData，res.blob) }) 2.22. request(options: object) 互通协议客户端可用，非客户端无效；时间：2019-08-28 options 参数： 参数 说明 类型 可选值 默认值 是否必填 api 互通协议接口 string - - 是 params 互通协议接口参数 object - - 否 jmsdkPC.request({ api: 'orderList', params: { orderStatus: 'WAIT_OUTBOUND' } }) 3. Error 类型 code 说明 message 1001 客户端版本过低，不支持API sorry, the version is too low to support the interface of xxx(api) 1002 在外部浏览器调用了只能在京麦客户端中使用的API sorry, the interface of xxx(api) can only be used in JM Client powered by Gitbook修订时间： 2021-06-28 20:19:48 |
今日新闻 |
推荐新闻 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |