下载文档

uexALiBaiChuan
更新时间:2016-08-04

1、简介

阿里百川插件

1.1、说明

封装了阿里百川sdk,百川是阿里巴巴旗下的无线开放平台,基于世界级的后端服务和成熟的商业组件,快速搭建App和提供卓越用户体验,开拓广告、商品、生活服务等无线新商业。此版本实现了阿里百川的基础功能:手淘授权登陆、退出登陆、获取登录者的信息、打开购物车、打开我的订单、通过itemid打开宝贝详情等。

  1. 注意:该插件会与uexAliPay(支付宝插件)相冲突,不建议两者同时使用。

1.2、UI展示

1.3、自定义插件下载

插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)
(自定义beta版插件下载上传到我的插件勾选使用)

2、API概览

2.1、方法

init 初始化阿里百川SDK

uexALiBaiChuan.init()

说明:

通过此方法初始化阿里百川SDK,这步首先要做,不然插件无反应。回调方法cbInit

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android 3.0.0+
iOS3.0.0+

示例:

  1. uexALiBaiChuan.init();

login 登录

uexALiBaiChuan.login();

说明:

通过此方法登录手机淘宝,如果没有安装手机淘宝,会使用H5打开。回调方法 cbLogin

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android 3.0.0+
iOS3.0.0+

示例:

  1. uexALiBaiChuan.login();

logout 退出登录

uexALiBaiChuan.logout();

说明:

通过此方法退出登录。回调方法cbLogout

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android 3.0.0+
iOS3.0.0+

示例:

  1. uexALiBaiChuan.logout();

getUserInfo 获取用户信息

var info = uexALiBaiChuan.getUserInfo();

说明:

通过此方法获取用户信息。

参数:

  1. 同步返回结果:
  2. 若用户已登录,则:
  3. info = {
  4. userId:,
  5. nick:,
  6. iconUrl:,
  7. loginTime:,
  8. authorizationCode:,
  9. isLogin:
  10. }
  11. 若用户未登录,则:
  12. info = {
  13. isLogin:
  14. }

返回结果各字段含义如下:

参数名称 参数类型 是否必选 说明
userId String 用户ID
nick String 用户昵称
iconUrl String 头像地址
loginTime String 登录时间
authorizationCode String 授权码
isLogin Number 登录状态,0为已登录,1为未登录(退出登录)

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android3.0.0+
iOS3.0.0+

示例:

  1. var info = uexALiBaiChuan.getUserInfo();
  2. alert(info);

openMyCart 打开购物车

uexALiBaiChuan.openMyCart(params)

说明:

通过此方法打开购物车页面。

参数:

  1. var params ={
  2. isvcode:
  3. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
isvcode String 自定义ISVCode,用于服务器订单跟踪。(如果服务器不做处理,可以不传)

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android 3.0.0+
iOS3.0.0+

示例:

  1. var params = {
  2. isvcode:"appcan"
  3. };
  4. uexALiBaiChuan.openMyCart(JSON.stringify(params));

openMyOrdersPage 打开订单列表

uexALiBaiChuan.openMyOrdersPage()

说明:

通过此方法打开订单列表页面。

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android 3.0.0+
iOS3.0.0+

示例:

  1. uexALiBaiChuan.openMyOrdersPage();

openItemDetailPageById 打开商品真实ID对应的详情页面

uexALiBaiChuan.openItemDetailPageById(params)

说明:

通过此方法打开打开商品真实ID对应的详情。

参数:

  1. var params ={
  2. isvcode:,
  3. itemid:,
  4. mmpid:
  5. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
isvcode String 自定义ISVCode,用于服务器订单跟踪。(如果服务器不做处理,可以不传)
itemid String 宝贝的id
mmpid String 阿里妈妈的pid,如果不是淘客的商品,该参数可以不传
  1. 参数说明:
  2. *itemid:宝贝的iditemid为打开宝贝详情后,看到浏览器里有id一项,如"https://item.taobao.com/item.htm?id=45535180986",这里的id就是itemid。注意:商品id.支持标准的商品ideg.37196464781;同时支持openItemIdeg.AAHd5d-HAAeGwJedwSnHktBI;必填,不允许为null
  3. *mmpid:阿里妈妈的pid,如果你还没有开通阿里妈妈-淘宝联盟账号,要去阿里妈妈开通账号并且补全账号信息以及绑定支付宝, 因为分销的商品最后是返回到阿里妈妈的账号,并通过支付宝提现拿到的;

平台支持:
Android2.2+
iOS6.0+

版本支持:
Android3.0.0+
iOS3.0.0+

示例:

  1. var params = {
  2. isvcode:"appcan",
  3. itemid : "45535180986",
  4. mmpid : "mm_175878368_0_0"
  5. };
  6. uexALiBaiChuan.openItemDetailPageById(JSON.stringify(params));

openItemDetailPageByURL 通过URL打开指定商品页面

uexALiBaiChuan.openItemDetailPageByURL(params)

说明:

通过URL打开指定商品页面。

参数:

  1. var params ={
  2. url:,
  3. mmpid:
  4. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
url String 商品的url地址
mmpid String 阿里妈妈的pid,如果不是淘客的商品,该参数可以不传

平台支持:
Android2.2+
iOS6.0+

版本支持:
Android3.0.0+
iOS3.0.0+

示例:

  1. var params = {
  2. url : "https://detail.tmall.com/item.htm?id=528887107325",
  3. mmpid : "mm_175878368_0_0"
  4. };
  5. uexALiBaiChuan.openItemDetailPageByURL(JSON.stringify(params));

2.2、回调方法

cbInit 对初始化的回调方法

uexALiBaiChuan.cbInit(data)

参数:
该字符串为JSON格式

  1. var data ={
  2. status:,
  3. errorCode:
  4. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
status Number 初始化状态,0为初始化成功,1为初始化失败
errorCode Number 错误标识码,初始化失败情况下存在

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android3.0.0+
iOS3.0.0+

示例:

  1. window.uexOnload = function(){
  2. uexALiBaiChuan.cbInit = function(state){
  3. alert(state);
  4. }
  5. }

cbLogin 对登录的回调方法

uexALiBaiChuan.cbLogin(data)

参数:
该字符串为JSON格式

  1. var data ={
  2. isLogin:
  3. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
isLogin Number 登录状态,0为已登录,1为未登录(退出登录)

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android3.0.0+
iOS3.0.0+

示例:

  1. window.uexOnload = function(){
  2. uexALiBaiChuan.cbLogin = function(state){
  3. alert(state);
  4. }
  5. }

cbLogout 对退出登录的回调方法

uexALiBaiChuan.cbLogout(data)

参数:
该字符串为JSON格式

  1. var data ={
  2. isLogin:
  3. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
isLogin Number 登录状态,0为已登录,1为未登录(退出登录)

平台支持:

Android2.2+
iOS6.0+

版本支持:

Android3.0.0+
iOS3.0.0+

示例:

  1. window.uexOnload = function(){
  2. uexALiBaiChuan.cbLogout = function(state){
  3. alert(state);
  4. }
  5. }

3、附录

3.1、如何获取mmpid及插件使用说明

  • 打开阿里百川官网,创建应用,进入控制台,点击SDK下载,iOS中输入bundleid,勾选电商能力包和淘宝登录基础包,生成阿里百川SDK,SDK会包含安全图片,图片名称为:yw_1222.jpg(请勿修改),该图片后面会使用到。生成的安全图片会包含bundleid的相关信息。若两者不匹配会导致移动端SDK初始化会失败或使用报错。
    image
    image
    image

  • 开通阿里妈妈链接地址会员。显示以下界面则说明开通成功 image

  • 在阿里百川官网控制台—> 证书管理权限下,权限能力中申请开通无线开放百川淘客包,如图image开通后即可显示阿里妈妈淘客PID即mmpid.image
  • 加入淘宝联盟链接地址
    imageimage
  • 插件使用,先买个乐高试试,链接地址
    image
    通过接口买了,
  1. var params = {
  2. itemid : "528887107325",
  3. mmpid : "mm_115873368_0_0"
  4. };
  5. uexALiBaiChuan.openItemDetailPageById(JSON.stringify(params));

这里有个省钱的测试方法,选中购买,到了付款界面退出,然后在去购物车找到这个订单,取消购买,看看是否能拿到钱,这里会显示有了,但是显示订单失效,原因是你取消了。
image
给你看看成功的订单,
image
另外,阿里的规则(每月1号结算上一个月成功订单的返现金额,20号将钱给你,到时候你要到结算中心,把他提现转到支付宝)

3.2、iOS插件配置说明

  • 本插件需要下载插件包,将生成的sdk中的安全图片替换掉uexALiBaiChuanGroup文件下原有的安全图片作为自定义插件上传才能正常使用。
  • 本插件需要config.xml配置Url Scheme,才能实现应用间的跳转,如:
  1. <config desc="uexALiBaiChuan" type="URLSCHEME">
  2. <urlScheme name="uexALiBaiChuan" schemes="['tbopen23367326']"/>
  3. </config>
  • tbopen23367326 分为两个部分: tbopen + App Key(23367326),tbopen为淘宝标识;App Key为在阿里百川控制台—>证书管理权限下的App Key,需要自己配置。

4、更新历史

iOS

API版本:uexALiBaiChuan-3.0.0

最近更新时间:2016-5-18

历史发布版本 更新内容
3.0.0 阿里百川插件

Android

API版本:uexALiBaiChuan-3.0.0

最近更新时间:2016-5-18

历史发布版本 更新内容
3.0.0 阿里百川插件