jdKepler

init

login

cancelAuth

openByH5

openPage

openDetail

openOrderList

openNav

openSearch

openShoppingCart

addToCart

概述

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

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

  • 名称：jdKepler
  • 参数：appKey_iOS、appSecret_iOS、urlScheme、appKey_android、appSecret_android
  • 配置示例:
  <feature name="jdKepler">
    <param name="appKey_iOS" value="a1a079063f304ad18a290102e07a850d" />
    <param name="appSecret_iOS" value="7faaab98b3d94f7baef0bbe8041fe28a" />
    <param name="appKey_android" value=""/>
    <param name="appSecret_android" value=""/>
    <param name="urlScheme" value="sdkbacka1a079063f304ad18a290102e07a850d" />
  </feature>

  • 字段描述:

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

    iOS 平台上添加白名单，如下： xml <preference name="querySchemes" value="openapp.jdmobile,jdlogin,weixin" />

iOS 平台注意： 在 管理平台 点击 SDK下载，输入iOS应用的BundleID，生成并下载SDK，将SDK打包成一个附加自定义插件上传 APICloud 平台。制作方法如下：下载 jdKeplerAppendix 插件 zip 包并解压，把 zip 包内 target 目录下的 JDKeplerSDK.framework 和 Kepler.bundle 文件替换为自己从京东开普勒平台获取的SDK。然后重新压缩为 zip 包文件上传自定义插件，云编译时勾选该插件。

注意： android 除了要配置上面的 appKey & keySecret 之外还需要使用安全图片，具体操作流程如下：

  • 到京东开普勒平台创建应用 传送门
  • 创建应用后在 “应用概览” 中可查看 appKey & keySecret
  • 在“sdk下载”中下载sdk，注意此处需要上传需要使用sdk的apk，（主要进行apk包名 & 签名验证）
  • 解压下载的sdk，在jdsdk_lib\src\main\res\raw 目录下找到 safe.jpg（即安全图片）
  • 下载配置插件 jdKeplerConfig，如果插件版本为1.0.4+， 下载自定义插件jdKeplerConfigV1，解压后将插件中的jdkepler_module-release.aar，如果插件版本为1.0.4+，解压文件jdkeplerconfig-release.aar（.aar文件可以使用标准解压软件解压，如360解压缩软件等） 文件再次解压，将上一步的安全图片放置在 res\raw 目录下即可（没有raw目录自己创建），再将jdkepler_module-release目录下的AndroidManifest.xml中的
<activity 
    android:exported="true" 
    android:name="com.kepler.jd.sdk.KeplerBackActivity" 
    android:theme="@android:style/Theme.Translucent">
            <intent-filter>
                <action android:name="android.intent.action.VIEW"/>
                <category android:name="android.intent.category.DEFAULT"/> 
                <data android:scheme="sdkbackc49b61cd6cb50123641e01e5a19cc0bb"/>
            </intent-filter>
</activity>

data 的标签用sdk目录下 src\main中的data标签替换掉，然后再次打包aar（选中（res,AndroidManifest.xml,classes.jar,R.txt）这些文件，然后压缩成zip格式并重命名为aar格式），最后再压缩为 jdKeplerConfigV1.zip，然后将jdKeplerConfigV1插件以自定义插件的形式（上传自定义插件后要点击加号）与jdKepler一块编译即可。

init

初始化sdk。 此接口仅支持Android。

init(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    success: true,   //布尔类型；初始化是否成功
}

示例代码

var jdKepler = api.require('jdKepler');
jdKepler.init(function(ret){
                    api.alert({
            msg: JSON.stringify(ret)
        })
               });

可用性

Android系统

可提供的1.0.0及更高版本

login

登录授权

login(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    success: true,   //布尔类型；是否成功
}

示例代码

var jdKepler = api.require('jdKepler');
jdKepler.login(function(ret){
                    api.alert({
            msg: JSON.stringify(ret)
        })
               });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancelAuth

取消授权

cancelAuth()

示例代码

var jdKepler = api.require('jdKepler');
jdKepler.cancelAuth();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openByH5

是否强制使用H5打开界面

openByH5({params})

params

h5：

  • 类型：布尔类型
  • 描述：是否强制使用H5打开界面，设置为false时，调用商品详情页，订单列表，购物车等方法时将跳转到京东app并打开对应的界面
  • 默认：true

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openPage

通过URL打开任意商品页面

openPage({params})

params

url：

  • 类型：字符串类型
  • 描述：（可选项）页面url
  • 默认：打开京东商城首页

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openDetail

通过SKU打开Kepler单品页

openDetail({params})

params

sku：

  • 类型：字符串类型
  • 描述：商品SKU
  • 默认：无

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openOrderList

打开订单列表

openOrderList({params})

params

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openNav

打开导航页

openNav({params})

params

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

var jdKepler = api.require('jdKepler');
jdKepler.openNav({});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openSearch

根据搜索关键字打开搜索结果页

openSearch({params})

params

searchKey：

  • 类型：字符串类型
  • 描述：搜索关键字
  • 默认：无

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openShoppingCart

打开购物车界面

openShoppingCart({params})

params

jumpType：

  • 类型：数值类型
  • 描述：（可选项）跳转类型 1代表present 2代表push
  • 默认：2

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addToCart

添加到购物车

addToCart({params},callback(ret,err))

params

sku：

  • 类型：字符串类型
  • 描述：商品sku
  • 默认：无

num：

  • 类型：字符串类型
  • 描述：（可选项）商品数量
  • 默认：1

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    success: true,   //布尔类型；是否成功
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 1,   // 数值类型；错误code
}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24