jdKepler

login openByH5 openDetail openNav openShoppingCart

概述

jdKepler 模块封装了京东开普勒导购模式SDK，在合作方的APP里嵌入京东的货架，由合作方引流至该货架，并形成闭环交易。和传统广告佣金模式对比将整套交易流程进行闭环，可提升客户体验，并提高订单转换率，享受完整的京东标准的配送和售后服务体系。开普勒导购模式能力开通流程

使用此模块之前必须先配置 config 文件，配置方法如下：

  • 名称：jdKepler
  • 参数：appKey_iOS、appSecret_iOS、urlScheme、appKey_android、appSecret_android
  • 配置示例:

  • 字段描述:

    appKey_iOS：京东开普勒平台创建应用的APP Key appSecret_iOS：京东开普勒平台创建应用的APP Secret appKey_android：京东开普勒平台创建应用的android APP Key appSecret_android：京东开普勒平台创建应用的android APP Secret urlScheme：用于实现应用间跳转及数据交换，urlScheme 的 value 值为sdkback+你的appKey_iOS

  2. ***iOS 平台注意：*** 在 管理平台 点击 SDK下载，输入iOS应用的BundleID，生成并下载SDK，将SDK打包成一个附加自定义模块上传 APICloud 平台。制作方法如下：下载 [jdKeplerAppendix](https://docs.apicloud.com/img/jdKepler/jdKeplerAppendix.zip) 模块 zip 包并解压，把 zip 包内 target 目录下的 JDKeplerSDK.framework 和 Kepler.bundle 文件替换为自己从京东开普勒平台获取的SDK。然后重新压缩为 zip 包文件上传自定义模块，云编译时勾选该模块。
  4. ***注意：*** android 除了要配置上面的 appKey & keySecret 之外还需要使用安全图片，具体操作流程如下：
  6. -   到京东开普勒平台创建应用 [传送门](http://kepler.jd.com/console)
  7. -   创建应用后在 “应用概览” 中可查看 appKey & keySecret
  8. -   在“sdk下载”中下载sdk，注意此处需要上传需要使用sdk的apk，（主要进行apk包名 & 签名验证）
  9. -   解压下载的sdk，在jdsdk\_lib\\src\\main\\res\\raw 目录下找到 safe.jpg（即安全图片）
  10. -   下载配置模块 [jdKeplerConfig](https://docs.apicloud.com/img/jdKepler/jdKeplerConfig.zip)，如果模块版本为1.0.4+， 下载自定义模块[jdKeplerConfigV1](https://docs.apicloud.com/img/jdKepler/jdKeplerConfigV1.zip)，解压后将模块中的jdkepler\_module-release.aar，如果模块版本为1.0.4+，解压文件jdkeplerconfig-release.aar（.aar文件可以使用标准解压软件解压，如360解压缩软件等） 文件再次解压，将上一步的安全图片放置在 res\\raw 目录下即可，再将jdkepler\_module-release目录下的AndroidManifest.xml中的

  2. data 的标签用sdk目录下 src\\main中的data标签替换掉，然后再次打包aar以及 jdKeplerConfig.zip，然后将jdKepler\_config模块以自定义模块的形式与jdKepler一块编译即可
  4. # init
  6. 初始化sdk。 此接口仅支持Android。
  8. init(callback(ret))
  10. ## callback(ret)
  12. ret：
  14. -   类型：JSON 对象
  15. -   内部字段：

{ success: true, //布尔类型；初始化是否成功 }

  2. ## 示例代码
  2. ## 可用性
  4. Android系统
  6. 可提供的1.0.0及更高版本
  8. # login
  10. 登录授权
  12. login(callback(ret))
  14. ## callback(ret)
  16. ret：
  18. -   类型：JSON 对象
  19. -   内部字段：

{ success: true, //布尔类型；是否成功 }

var jdKepler = api.require(‘jdKepler’); jdKepler.login(function(ret){ alert(JSON.stringify(ret)); });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # cancelAuth
  10. 取消授权
  12. cancelAuth()
  14. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.cancelAuth();

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # openByH5
  10. 是否强制使用H5打开界面
  12. openByH5({params})
  14. ## params
  16. h5：
  18. -   类型：布尔类型
  19. -   默认：true
  21. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openByH5({ h5 : false });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # openPage
  10. 通过URL打开任意商品页面
  12. openPage({params})
  14. ## params
  16. url：
  18. -   类型：字符串类型
  19. -   描述：（可选项）页面url
  20. -   默认：打开京东商城首页
  22. jumpType：
  24. -   类型：数值类型
  25. -   描述：（可选项）跳转类型 1代表present 2代表push
  26. -   默认：2
  28. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openPage({ });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # openDetail
  10. 通过SKU打开Kepler单品页
  12. openDetail({params})
  14. ## params
  16. sku：
  18. -   类型：字符串类型
  19. -   描述：商品SKU
  20. -   默认：无
  22. jumpType：
  24. -   类型：数值类型
  25. -   描述：（可选项）跳转类型 1代表present 2代表push
  26. -   默认：2
  28. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openDetail({ sku : ‘1152042’ });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # openOrderList
  10. 打开订单列表
  12. openOrderList({params})
  14. ## params
  16. jumpType：
  18. -   类型：数值类型
  19. -   描述：（可选项）跳转类型 1代表present 2代表push
  20. -   默认：2
  22. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openOrderList({ });

  2. ## 可用性
  4. iOS系统，Android系统
  7. # openSearch
  9. 根据搜索关键字打开搜索结果页
  11. openSearch({params})
  13. ## params
  15. searchKey：
  17. -   类型：字符串类型
  18. -   描述：搜索关键字
  19. -   默认：无
  21. jumpType：
  23. -   类型：数值类型
  24. -   描述：（可选项）跳转类型 1代表present 2代表push
  25. -   默认：2
  27. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openSearch({ searchKey : ‘macbookPro’ });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # openShoppingCart
  10. 打开购物车界面
  12. openShoppingCart({params})
  14. ## params
  16. jumpType：
  18. -   类型：数值类型
  19. -   描述：（可选项）跳转类型 1代表present 2代表push
  20. -   默认：2
  22. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.openShoppingCart({ });

  2. ## 可用性
  4. iOS系统，Android系统
  6. 可提供的1.0.0及更高版本
  8. # addToCart
  10. 添加到购物车
  12. addToCart({params},callback(ret,err))
  14. ## params
  16. sku：
  18. -   类型：字符串类型
  19. -   描述：商品sku
  20. -   默认：无
  22. num：
  24. -   类型：字符串类型
  25. -   描述：（可选项）商品数量
  26. -   默认：1
  28. ## callback(ret,err)
  30. ret：
  32. -   类型：JSON 对象
  33. -   内部字段：

{ success: true, //布尔类型；是否成功 }

  2. err：
  4. -   类型：JSON 对象
  5. -   内部字段：

{ code: 1, // 数值类型；错误code }

  2. ## 示例代码

var jdKepler = api.require(‘jdKepler’); jdKepler.addToCart({ sku : ‘1152042’, num : ‘2’ },function(ret,err){ if (ret.success) { alert(JSON.stringify(ret)); }else { alert(JSON.stringify(err)); } }); ```

iOS系统，Android系统

可提供的1.0.0及更高版本