alibaic

立即使用

Method

init setForTaoke setTaokeParams setChannel login logout getUser detailPage addCartPage myOrders myCarts shopPage pageByUrl detailPageWeb addCartPageWeb myOrdersWeb myCartsWeb shopPageWeb pageByUrlWeb addWebFinishListener addStartLoadingListener addJsToH5 removeJs setFilterUrl goBack removeWeb setISVCode setISVVersion

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

alibaic模块 封装了阿里百川电商sdk(4.0.0.2)，能够使你的app快速集成淘宝的电商功能，包括授权登录，查看商品详情，查看店铺，查看我的订单，查看购物车和商品支付等整个交易闭，使你能够更随心的定义自己的界面,支持用H5实现“APP内交易闭环”或拉起手机淘宝实现“外呼手淘交易闭环”,详情请查看淘宝公告 。使用此模块，需要登录阿里百川，进入控制台，创建应用并获取sdk的安全图片。

模块概述

封装了阿里百川电商sdk，快速集成淘宝的电商功能

准备事项

一，创建应用并获取AppKey Image text 二，申请API权限： Image text 三，开通百川电商sdk： Image text 四，生成安全图片(使用V5版安全图片)： Image text

五，配置 自定义模块 alibaicKey：

首先下载 alibaicKey模块 alibaicKey.zip ) ，将安全图片 yw_1222.jpg 更换，重新打包成zip，即可作为自定义模块使用

六，开通阿里妈妈 1、开通阿里妈妈会员，获取淘客PID（返利用），打开阿里妈妈传送门,显示以下界面则说明开通成功 Image text 2、需要人工审，一般1-2个工作日

七，加入淘宝联盟

1、用于查看收益，并把收益转入支付宝，点此加入淘宝联盟

2、需要人工审核，一般1-2个工作日

八，配置 config.xml 文件：(tbopen + AppKey)

  1.  <preference name="querySchemes" value="tbopen,tmall"/>
  2.   <feature name="alibaic">
  3.     <param name="urlScheme" value="tbopen234155822"/>
  4.   </feature>

注意

本模块可以与aliPayTradePlus模块同时使用 不能与aliPayTrade同时使用

模块接口

init

初始化SDK（优先级最高，只调用一次）

init({param},callback(ret))

params

-addLoginEvent：

-类型：布尔类型

-默认值：true

-描述：（可选项）是否对淘宝授权登录事件进行监听，设置监听后登录淘宝会触发一个名为“BCLoginEvent”的广播事件，可通过api.addEventListener对该事件进行监听。

-示例

-设置监听后可以添加api事件监听来获取相关信息：

  1.  api.addEventListener({name: 'BCLoginEvent'}, function(ret) {
  3.    console.log(ret.openSid+','+ret.openId+','+ret.nick+','+ret.avatarUrl);
  5. });

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段： { code : 0|-1, //数字型0 成功 -1失败 type : 0|1, //数字型0 成功 -1失败 message:’淘宝初始化成功’ //字符串，提示信息 }

示例代码

  1. var alibaic = api.require('alibaic');
  2.    alibaic.init({
  3.        addLoginEvent:false
  4.     },function(ret){
  5. });

可用性

Android,ios系统

可提供的1.0.1

setForTaoke

设置SDK 淘客打点策略（默认采用淘客同步打点,注意：初始化完成后调用才能生效）

setForTaoke({params}, callback(ret))

params

isForTaoke：

-类型：布尔类型

-默认值：true

-描述：（可选项）设置是否使用同步淘客打点。true：使用淘客同步打点；false：关闭同步打点，使用异步打点。

-注意：在加购场景下，只有异步淘客打点

callback(ret)

ret：

-类型：JSON对象

-描述：返回值 仅Android有返回

-内部字段：{ code : 0|-1, //数字型0 成功 -1失败 message:’设置淘客打点策略成功’ //字符串，提示信息 }

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setForTaoke({isForTaoke:false},
  3.       function(ret){
  4.             alert(JSON.stringify(ret));
  5. });

可用性

Android,ios系统

可提供的1.0.1

setTaokeParams

设置淘客全局参数

setTaokeParams({params}, callback(ret))

params

pid：

-类型：字符串

-描述：淘客pid,获取流程参考：http://baichuan.taobao.com/portal/doc?articleId=220

-注意：在加购场景下，只有异步淘客打点

taokeAppkey：

-类型：字符串

-描述：(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需， 如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 功能介绍

adzoneId：

-类型：字符串

-描述：(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需， 如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 功能介绍

-注意：在加购场景下，只有异步淘客打点,adzoneid是需要taokeAppkey参数才可以转链成功&店铺页面需要卖家id（sellerId)

sellerId：

-类型：字符串

-描述：如果是打开店铺页面(shop)，需要在extraParams中显式传入sellerId，否则同步打点转链失败

callback(ret)

ret：

-类型：JSON对象

-描述：返回值 仅Android有返回

-内部字段：code: 0|-1 //数字型，0设置成功 -1设置失败}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setTaokeParams({
  3.                   pid:'mm_xxxx_xxxx_xxxx',
  4.                   taokeAppkey:'',
  5.                   adzoneId:'',
  6.                   sellerId:'',//可选
  7.                   unionId:'',//可选
  8.                   subPid:''//可选
  9.                   },
  10.                  function(ret){
  11.                         alert(JSON.stringify(ret));
  12.         });

可用性

Android,ios系统

可提供的1.0.1

setChannel

设置渠道信息（如果有渠道专享价，需要设置）

setChannel({params})

params

typeName：

-类型：字符串

-默认值：“0”

-描述：（可选项）设置渠道类型

channelName：

-类型：字符串

-默认值：null

-描述：（可选项）设置渠道名称

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setChannel({
  3.           typeName:'0',
  4.           channelName:'developer'
  5.          });

可用性

Android,ios系统

可提供的1.0.1

login

授权登录

login(callback(ret))

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,             //0登录成功 -1 失败
  2. isLogin : true,         //是否授权登录成功
  3. nick : '',              //昵称
  4. avatarUrl : '',         //头像地址
  5. openId : '',            //用户标识
  6. openSid : '',           //用户标识
  7. userid : '',            //仅android有此返回值
  8. topExpireTime : '',     //仅android有此返回值
  9. topAccessToken:''       
  10. topAuthCode : ''

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.login(function(ret){
  3.     if(ret.code==0){
  4.         alert(JSON.stringify(ret));
  5.     }
  7. });

可用性

Android,ios系统

可提供的1.0.1

logout

注销

logout(callback(ret))

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,              //数值型，0成功-1失败

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.logout(function(ret){
  3.     if(ret.code==0){
  4.         alert(JSON.stringify(ret));
  5.     }else{
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

Android,ios系统

可提供的1.0.1

getUser

获取用户信息

getUser(callback(ret))

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,             //数值型，0成功 -1失败
  2. isLogin : true,         //是否授权登录了淘宝
  3. nick : '',              //昵称
  4. avatarUrl : '',         //头像地址
  5. openId : '',            //用户标识
  6. openSid : '',           //用户标识
  7. userid : '',            //仅android有此返回值
  8. topExpireTime : '',     //仅android有此返回值
  9. topAccessToken:''        
  10. topAuthCode : ''

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.getUser(function(ret){
  3.     if(ret.code==0){
  4.         alert(JSON.stringify(ret));
  5.     }else{
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

Android,ios系统

可提供的1.0.1

detailPage

打开淘宝商品详情页

detailPage({params},callback(ret))

params

itemId：

-类型：字符串

-描述：商品id。支持itemId和openItemId的商品（如：37196464781L，AAHd5d-HAAeGwJedwSnHktBI），必填，不允许为null

bizCode：

-类型：字符串

-描述：”detail”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

openType：

-类型：字符串

-默认：’auto’

-描述：(可选项)打开页面的方式：拉起手淘/天猫 ，默认值：auto -取值范围：’auto’(智能判断) native’(手机淘宝/天猫)

linkKey：

-类型：字符串

-默认：无

-描述：(可选项)当打开页面的方式（openType）为native时，设置拉起手淘or天猫。（不传则走百川默认设置，建议传值）

-取值范围：’tmall’ //拉起天猫 ‘taobao’ //拉起手淘

taokeAppkey：

-类型：字符串

-描述：(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需， 如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 并且openType设置为’native’ 功能介绍

adzoneId：

-类型：字符串

-描述：(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需， 如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 并且openType设置为’native’ 功能介绍

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                       //数值型，0购买操作成功 -1操作成功
  2. ordersId : [],                    //字符串数组，购买成功后返回的订单号

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.detailPage(
  3.     {
  4.         itemId:'37196464781L',
  5.         bizCode:'detail',
  6.         openType:'auto',
  7.         pid:'mm_xxxxxx_xxxxxx',
  8.         unionId:'',//可选
  9.         subPid:''//可选
  10.     }，function(ret){
  11.         if(ret){
  12.             alert(JSON.stringify(ret));
  13.         }
  14. });

可用性

Android,ios系统

可提供的1.0.1

addCartPage

打开购物车页面

addCartPage({params},callback(ret))

params

itemId：

-类型：字符串

-描述：商品id。支持itemId和openItemId的商品（如：37196464781L，AAHd5d-HAAeGwJedwSnHktBI），必填，不允许为null

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

callback(ret)

ret：

-类型：JSON对象

-描述：加购/购买成功后返回

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. message : '加购成功',              //字符串，仅在加购成功后返回的提示信息
  3. ordersId : [],                    //字符串数组，仅在购买成功后返回的订单号

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.addCartPage(
  3.     {
  4.         itemId：'37196464781L',
  5.         openType:'auto',
  6.         pid:''
  7.         unionId:'',//可选
  8.         subPid:''//可选
  9.     }，function(ret){
  10.         if(ret){
  11.             alert(JSON.stringify(ret));
  12.         }
  13. });

可用性

Android,ios系统

可提供的1.0.1

myOrders

我的订单页面

myOrders({params},callback(ret))

params

orderStatus：

-类型：int

-默认：0

-描述：默认跳转页面。0：全部；1：待付款；2：待发货；3：待收货；4：待评价allOrder：

-类型：布尔型

-默认：false

-描述：false 进行订单分域（只展示通过当前app下单的订单），true 显示所有订单

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType：

-类型：字符串

-默认：’auto’

-描述：(可选项)打开页面的方式：拉起手淘/天猫，默认值：auto

-取值范围：’auto’ //智能判断’ native’ //手机淘宝/天猫

linkKey：

-类型：字符串

-默认：无

-描述：(可选项)当打开页面的方式（openType）为native时，设置拉起手淘or天猫。（不传则走百川默认设置，建议传值）

-取值范围：’tmall’ //拉起天猫 ‘taobao’ //拉起手淘

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

callback(ret)

ret：

-类型：JSON对象

-描述：购买成功后返回

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.myOrders(
  3.     {
  4.         orderStatus：0,
  5.         allOrder：false
  6.         pid:''
  7.         unionId:'',//可选
  8.         subPid:''//可选
  9.     }，function(ret){
  10.         if(ret){
  11.             alert(JSON.stringify(ret));
  12.         }      
  13. });

可用性

Android,ios系统

可提供的1.0.1

myCarts

我的购物车

myCarts({params},callback(ret))

params

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

bizCode：

-类型：字符串

-描述：”cart”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

openType：

-类型：字符串

-默认：’auto’

-描述：(可选项)打开页面的方式：拉起手淘/天猫

-取值范围：’auto’ //智能判断 ‘native’ //手机淘宝/天猫

linkKey：

-类型：字符串

-默认：无

-描述：(可选项)当打开页面的方式（openType）为native时，设置拉起手淘or天猫。（不传则走百川默认设置，建议传值）

-取值范围：’tmall’ //拉起天猫 ‘taobao’ //拉起手淘

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

callback(ret)

ret：

-类型：JSON对象

-描述：购买成功后返回

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.myCarts(
  3.     {
  4.         pid:'',
  5.         unionId:'',//可选
  6.         subPid:''//可选
  7.         bizCode:'cart'
  8.     }，function(ret){
  9.         if(ret){
  10.             alert(JSON.stringify(ret));
  11.         }      
  12. });

可用性

Android,ios系统

可提供的1.0.1

shopPage

淘宝店铺页面

shopPage({params},callback(ret))

params

shopId：

-类型：字符串

-描述：店铺id，支持明文id

bizCode：

-类型：字符串

-描述：”shop”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

openType：

-类型：字符串

-默认：’auto’

-描述：(可选项)打开页面的方式：拉起手淘/天猫

-取值范围：’auto’ //智能判断 ‘native’ //手机淘宝/天猫

linkKey：

-类型：字符串

-默认：无

-描述：(可选项)当打开页面的方式（openType）为native时，设置拉起手淘or天猫。（不传则走百川默认设置，建议传值）

-取值范围：’tmall’ //拉起天猫’taobao’ //拉起手淘

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

sellerId：

-类型：字符串

-描述：如果是打开店铺页面(shop)，需要在extraParams中显式传入sellerId，否则同步打点转链失败

callback(ret)

ret：

-类型：JSON对象

-描述：购买成功后返回

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.shopPage(
  3.     {
  4.         shopId：'60332011',
  5.         openType:'auto',
  6.         bizCode:'shop',
  7.         pid:''
  8.         sellerId:'',//可选
  9.        unionId:'',//可选
  10.        subPid:''//可选
  11.     }，function(ret){
  12.         if(ret){
  13.             alert(JSON.stringify(ret));
  14.         }       
  15. });

可用性

Android,ios系统

可提供的1.0.1

pageByUrl

打开url展示页面

pageByUrl({params},callback(ret))

params

url：

-类型：字符串

-描述：url

openType：

-类型：字符串

-默认：’auto’

-描述：(可选项)打开页面的方式：拉起手淘/天猫

-取值范围：’auto’ //智能判断 ‘native’//手机淘宝/天猫

linkKey：

-类型：字符串

-默认：无

-描述：(可选项)当打开页面的方式（openType）为native时，设置拉起手淘or天猫。（不传则走百川默认设置，建议传值）

-取值范围：’tmall’ //拉起天猫’taobao’ //拉起手淘pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

taokeAppkey：

-类型：字符串

-描述：(可选项) 淘宝联盟后台的APPKEY字段。新版本SDK新增 高佣转链/跨店结算 功能所需， 如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 并且openType设置为’native’

adzoneId：

-类型：字符串

-描述：(可选项)淘宝联盟adzoneId。新版本SDK新增 高佣转链/跨店结算 功能所需， -如果需要高分佣能力，务必传入adzoneId和taokeAppkey 参数 并且openType设置为’native’

pageClose：

-类型：布尔型

-默认：true

-描述：(可选项) 购买商品支付成功后是否关闭淘宝页面。true:关闭，false:不关闭。仅Android有效

callback(ret)

ret：

-类型：JSON对象

-描述：购买成功后返回

-内部字段：

{

  1.  code: 0|-1,                       //数值型，0 成功 -1 失败
  2.  ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  3. alibaic.pageByUrl(
  4.     {
  5.         url：'',
  6.         pid:''，
  7.         pageClose:false
  8.     }，function(ret){
  9.         if(ret){
  10.             alert(JSON.stringify(ret));
  11.         }     
  12. });

可用性

Android,ios系统

可提供的1.0.1

detailPageWeb

外部webview打开淘宝商品详情页

detailPageWeb({params},callback(ret))

params

itemId：

-类型：字符串

-描述：商品id。支持itemId和openItemId的商品（如：37196464781L，AAHd5d-HAAeGwJedwSnHktBI），必填，不允许为null

-注意：客户端openItemId（或者openId）即将下线，请注意使用。

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

bizCode：

-类型：字符串

-描述：”detail”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 }

fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，购买成功后返回的订单号

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.detailPageWeb(
  3.     {
  4.         itemId：'37196464781L',
  5.         pid:''，
  6.         bizCode:'detail',
  7.         rect:{
  8.             x:0,
  9.             y:0,
  10.             w:'auto',
  11.             h:480
  12.         },
  13.         jsObjectName:'alibaic'
  14.     }，function(ret){
  15.         if(ret){
  16.             alert(JSON.stringify(ret));
  17.         }
  18. });

可用性

Android,ios系统

可提供的1.0.1

addCartPageWeb

外部webview方式，打开淘宝加入购物车页面

addCartPageWeb({params},callback(ret))

params

itemId：

-类型：字符串

-描述：商品id。支持itemId和openItemId的商品（如：37196464781L，AAHd5d-HAAeGwJedwSnHktBI），必填，不允许为null

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 }

fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：加购/购买成功后返回

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. message : '加购成功',              //字符串，仅在加购成功后返回的提示信息
  3. ordersId : [],                    //字符串数组，仅在购买成功后返回的订单号

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.addCartPageWeb(
  3. {
  4.         itemId：'37196464781L',
  5.         pid:''，
  6.         rect:{
  7.             x:0,
  8.             y:0,
  9.             w:'auto',
  10.             h:480
  11.         },
  12.         jsObjectName:'alibaic'
  13.     }，function(ret){
  14.         if(ret){
  15.             alert(JSON.stringify(ret));
  16.         }     
  17. });

可用性

Android,ios系统

可提供的1.0.1

myOrdersWeb

外部webview方式，打开我的订单页面

myOrdersWeb({params},callback(ret))

params

orderStatus：

-类型：int

-默认：0

-描述：默认跳转页面。0：全部；1：待付款；2：待发货；3：待收货；4：待评价

allOrder：

-类型：布尔型

-默认：false

-描述：false 进行订单分域（只展示通过当前app下单的订单），true 显示所有订单

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 } fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  3. alibaic.myOrdersWeb(
  4.      {
  5.         orderStatus：0,
  6.         allOrder：false,
  7.         pid:''，
  8.         rect:{
  9.             x:0,
  10.             y:0,
  11.             w:'auto',
  12.             h:480
  13.         },
  14.         jsObjectName:'alibaic'
  15.     }，function(ret){
  16.         if(ret){
  17.             alert(JSON.stringify(ret));
  18.         }      
  19. });

可用性

Android,ios系统

可提供的1.0.1

myCartsWeb

外部webview方式，打开我的购物车

myCartsWeb({params},callback(ret))

params

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

bizCode：

-类型：字符串

-描述：”cart”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 }

fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.myCartsWeb(
  3.     {
  4.         pid:''，
  5.         bizCode:'cart',
  6.         rect:{
  7.             x:0,
  8.             y:0,
  9.             w:'auto',
  10.             h:480
  11.         },
  12.         jsObjectName:'alibaic'
  13.     }，function(ret){
  14.         if(ret){
  15.             alert(JSON.stringify(ret));
  16.         }       
  17. });

可用性

Android,ios系统

可提供的1.0.1

shopPageWeb

外部webview方式，打开淘宝店铺页面

shopPageWeb({params},callback(ret))

params

shopId：

-类型：字符串

-描述：店铺id，支持明文id

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

bizCode：

-类型：字符串

-描述：”shop”。

-注意：后台申请的官方页面pageCode 目前支持“detail” “cart” “shop”.后续会开放更多的pageCode

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 }

fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                       //数值型，0 成功 -1 失败
  2. ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.shopPageWeb(
  3.     {
  4.         shopId：'60552065',
  5.         pid:'',
  6.         bizCode:'shop',
  7.         rect:{
  8.             x:0,
  9.             y:0,
  10.             w:'auto',
  11.             h:480
  12.         },
  13.         jsObjectName:'alibaic'
  14.     }，function(ret){
  15.         if(ret){
  16.             alert(JSON.stringify(ret));
  17.         }       
  18. });

可用性

Android,ios系统

可提供的1.0.1

pageByUrlWeb

外部webview方式，打开url展示页面

pageByUrlWeb({params},callback(ret))

params

url：

-类型：字符串

-描述：url

pid：

-类型：字符串

-描述：(可选项) 淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

rect：

-类型：JSON 对象

-默认值：充满整个父页面

-描述：（可选项）frame 的位置和大小。

-内部字段： { x:0, //左上角x坐标 y:0, //左上角y坐标 w:320, //宽度，若传’auto’，页面从x位置开始自动充满父页面宽度 h:480 //高度，若传’auto’，页面从y位置开始自动充满父页面高度 }

fixedOn：

-类型：字符串类型

-描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

-默认：模块依附于当前 window

fixed:

-类型：布尔

-默认值：true

-描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

jsObjectName：

-类型：字符串

-描述：(可选项) 注入到h5页面的全局window属性对象名称，可与addJsToPage配合使用。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1.  code: 0|-1,                       //数值型，0 成功 -1 失败
  2.  ordersId : [],                    //字符串数组，订单号数组

}

示例代码

  1. var alibaic = api.require('alibaic');
  3. alibaic.pageByUrlWeb(
  4.     {
  5.         url：'',
  6.         pid:''，
  7.         rect:{
  8.             x:0,
  9.             y:0,
  10.             w:'auto',
  11.             h:480
  12.         },
  13.         jsObjectName:'alibaic'
  14.     }，function(ret){
  15.         if(ret){
  16.             alert(JSON.stringify(ret));
  17.         }     
  18. });

可用性

Android,ios系统

可提供的1.0.1

addWebFinishListener

监听页面加载完成后返回页面的title和url。

addWebFinishListener(callback(ret))

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                //数值型，0 取到title 和 url -1 失败
  2. title : '',                //页面的标题
  3. url : '',                  //页面的url

}

示例代码

  1. var alibaic = api.require('alibaic');
  3. alibaic.addWebFinishListener(function(ret){
  4.     if(ret.code==0){
  5.         alert(JSON.stringify(ret));
  6.     }      
  7. });

可用性

Android,ios系统

可提供的1.0.1

addStartLoadingListener

页面shouldStartLoadWithRequest时进行监听，返回页面的title和跳转的url。

addStartLoadingListener(function(ret){

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                //数值型，0 取到title 和 url -1 失败
  2. title : '',                //页面的标题
  3. url : '',                 //页面的url

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.addStartLoadingListener(function(ret){
  3.     if(ret.code==0){
  4.         alert(JSON.stringify(ret));
  5.     }
  6. });

可用性

Android,ios系统

可提供的1.0.1

addJsToH5

在当前打开的淘宝页面加载完成后注入一段js脚本到H5页面。

addJsToH5({params}, callback(ret))

params

javaScript：

-类型：字符串

-描述：javaScript脚本

-注意：必须以”javascript:{内容}”的格式

appointUrl：

-类型：字符串

-描述：(可选项)指定Js脚本注入到的页面 默认值：”all” all //所有H5页面 justHome //仅首页

-注意：以http开头的url字符串 //仅该指定的url页面

delay：

-类型：Double

-描述：(可选项)延时执行js脚本的时间，单位为 s（秒） 默认值：0

once：

-类型：布尔型

-描述：(可选项)回调成功一次后是否清除对Javascript函数的引用，便于内存回收。通常为false。

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{ code: 0|-1, //数值型，0 获取成功 -1 失败 string: ‘’ //字符串 array0: [] //数组（Android中只支持字符串数组） array1: [] //数组（Android中只支持字符串数组） }

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.addJsToH5(
  3.     {
  4.         javaScript:'javascript:{window.jsObjectName.jsCallBack("测试",null,null)}'//jsObjectName替换为打开淘宝页面时传的 jsObjectName 参数。
  5.     },function(ret,err){
  6.         if(ret.code==0){
  7.              alert(JSON.stringify(ret));
  8.         }
  9.     }
  10. );

可用性

Android,ios系统

可提供的1.0.1

removeJs

移除页面加载完成的监听和js脚本。

removeJs({params}, callback(ret))

params

name：

-类型：字符串

-描述：(可选项) 移除的类型，javaScript脚本/pageFinishedListener/addStartLoadingListener/javaScript (默认为 同时移除javaScript脚本)

callback(ret)

ret：

-类型：JSON对象

-描述：返回值

-内部字段：

{

  1. code: 0|-1,                //数值型，0 成功 -1 失败

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.removeJs({name:'pageFinishedListener'}function(ret){
  3.     if(ret.code==0){
  4.         alert(JSON.stringify(ret));
  5.     }
  6. });

可用性

Android,ios系统

可提供的1.0.1

setFilterUrl

设置要拦截的url。(当使用外部webview方式打开百川页面时 有效)

setFilterUrl({param},callback(ret))

params

filterUrl：

-类型：字符串

-描述：要拦截的url

callback(ret)

ret：

-类型：JSON对象

-内部字段：

{

  1. code: 0,                         //数值型，0
  2. message : '置要拦截的url成功',        //字符串，提示信息

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setFilterUrl({filterUrl:''},function(ret){
  3.     alert(JSON.stringify(ret));   
  4. });

可用性

Android,ios系统

可提供的1.0.1

goBack

控制当前外部的webview回退

goBack(callback(ret))

callback(ret)

ret：

-类型：JSON对象

-描述：当webview不能回退时返回

-内部字段：

{

  1. code: 0,                         //数值型，0
  2. message : '最后一个页面了',        //字符串，提示信息

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.goBack(function(ret){
  3.     alert(JSON.stringify(ret));   
  4. });

可用性

Android,ios系统

可提供的1.0.1

removeWeb

从视图中移除当前通过xxxWeb打开的百川页面。

removeWeb()

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic..removeWeb();

可用性

Android,ios系统

可提供的1.0.1

setISVCode

设置isvcode全局接口。

setISVCode({params},callback(ret))

params

isvCode：

-类型：字符串

-描述：isvcode

callback(ret)

ret：

-类型：JSON对象

-内部字段：

{

  1. code: 0,                                               //数值型，0
  2. message : '设置isvcode全局接口成功',        //字符串，提示信息

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setISVCode({isvCode:''},function(ret){
  3.     alert(JSON.stringify(ret));   
  4. });

可用性

Android,ios系统

可提供的1.0.1

setISVVersion

设置ISVVersion全局接口。

setISVVersion({params},callback(ret))

params

isvCode：

-类型：字符串

-描述：isvVersion

callback(ret)

ret：

-类型：JSON对象

-内部字段：

{

  1. code: 0,                                               //数值型，0
  2. message : '设置ISVVersion成功',        //字符串，提示信息

}

示例代码

  1. var alibaic = api.require('alibaic');
  2. alibaic.setISVVersion({ISVVersion:''},function(ret){
  3.     alert(JSON.stringify(ret));   
  4. });

可用性

Android,ios系统

可提供的1.0.1