aliTradePlus

来自于：开发者

initSDK showLogin logout showItemDetailPage showPage showCartsPage addItem2Cart showMyOrders showShopPage

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

该模块已停止维护，请使用该模块的优化版alibcTrade模块。aliTradePlus是aliTrade的升级版， 封装了阿里百川电商sdk，能够使你的app快速集成淘宝的电商功能，包括授权登录，查看商品详情，查看店铺，查看我的订单，查看购物车和商品支付等整个交易闭环，使用本模块需要遵从阿里百川的申请流程，需要登录阿里百川，进入控制台，创建应用并获取sdk的安全图片，此外该模块需要和 aliTradeAppendix（该模块为自定义模块）模块绑定使用. 注意:本次更新了3.1.1.205的SDK，在使用时请重新下载最新的安全图片，因为我使用SDK的版本原因，选择图片版本的时候请使用V4版安全图片，否则会造成API未授权的情况

阿里百川电商SDK

向开发者提供标准化的商品、交易、支付组件，配合相应的数据服务，应用内建造商城不再困难。

打开手机淘宝，直接同步手机淘宝登录状态，用户无需再次输入账号密码，登录转化率提升2倍。

应用可以直接呼起手机淘宝，用户在手机淘宝内完成交易流程，成交提升3-5倍。

支持App与手机淘宝间互相跳转，用户可通过”Tip”随时从手机淘宝快速返回App。

客户案例

什么值得买、优酷、新浪微博、今日头条、小米生活、美柚、果库、她社区、小恩爱、半塘、爱豆、礼物说、虎扑识货、中华万年历、抢货、疯狂造人、高德地图、路口、毒物、惠喵、优衣库

基本流程

  1. 在阿里百川控制台创建应用获取appkey：
    appkey

  2. 在阿里百川控制台“API申请”中申请相应的API权限：
    api

  3. 在阿里百川控制台”我的产品后台”中开通新版百川电商sdk：
    background

  4. 生成安全图片：(android 需要上传apk，即为自己要发布的应用，iOS只需要填写 bundleId：可在apicloud控制台概览里查看)
    create_security

  5. 配置 Android 自定义模块 aliTradeAppendix：

    首先下载 aliTradeAppendix 模块，将其解压并将Android的安全图片 yw_1222.jpg 放到文件夹 aliTradeAppendix\res_aliTradeAppendix\res\drawable 下，重新打包成zip，即可作为自定义模块使用

  6. 配置 iOS 自定义模块 aliTradeAppendix：

    首先下载 aliTradeAppendix 模块，将其解压并将iOS的安全图片 yw_1222.jpg 放到 aliTradeAppendix/target 目录下，重新打包成zip，即可作为自定义模块使用

使用此模块之前需先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：aliTradePlus
  • 参数：urlScheme, querySchemes
  • 参数说明：
    • urlScheme参数用于处理应用间的跳转，值为tbopen+appkey, appkey是在阿里百川上申请的appkey.
    • querySchemes参数用于配置可被检测的URL Scheme,多个参数用逗号隔开，本模块需添加tbopen,tmall两个参数.
  • 配置示例：
  1.  <preference name="urlScheme" value="tbopen23442471"/>
  2.  <preference name="querySchemes" value="tbopen,tmall"/>

initSDK

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

initSDK({params},callback(ret))

params

isVVersion：

  • 类型：字符串
  • 描述：(可选)设置App版本,可用于标识App版本,服务器若不做处理，可不传

isVCode:

  • 类型：（可选）字符串
  • 描述：(可选)设置App标识字段,和isvcode同义,可用于区分使用本SDK的具体App,服务器若不做处理，可不传

callback(ret, err)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status : true // 布尔类型；是否初始化成功
  3. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.initSDK({
  3.    isVVersion: '',
  4.    isVCode: ''
  5. },function(ret, err){
  6.     if(ret.status){
  7.         alert(JSON.stringify(ret));
  8.     } else {
  9.         alert(JSON.stringify(err));
  10.     }
  11. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showLogin

授权登录

showLogin(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.    isLogin : true,          //是否授权登录成功
  3.     nick : '',               //昵称
  4.     avatarUrl : '',          //头像地址
  5.     openId : '',             //用户标识
  6.     openSid : ''             //用户标识
  7.     topAccessToken:''        //仅iOS有此返回值
  8. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showLogin(function(ret, err){
  3.        if (ret) {
  4.            alert(JSON.stringify(ret));
  5.        }else {
  6.             alert(JSON.stringify(err));
  7.        }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

注销

logout(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status:true  // 布尔类型；返回登录状态
  3. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.logout(function(ret, err){
  3.         alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showItemDetailPage

显示商品详情

showItemDetailPage({params},callback(ret))

params

itemId：

  • 类型：字符串
  • 描述：商品id

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式：拉起手淘和h5打开页面，默认值：auto
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status:true  // 布尔类型；返回交易状态
  3. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showItemDetailPage({
  3.     itemId: '41576306115',
  4.     taokePid: '',
  5.     openType: 'auto'
  6. },function(ret, err){
  7.     if(ret.status){
  8.         alert(JSON.stringify(ret));
  9.     } else {
  10.         alert(JSON.stringify(err));
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showPage

用url打开商品页面

showPage({params},callback(ret))

params

url：

  • 类型：字符串
  • 描述：页面url地址

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式：拉起手淘和h5打开页面，默认值：auto
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值，如果openType为h5，且交易成功，则有返回值
  2. {
  3.      status:true,                 // 布尔类型；返回交易状态
  4.      orderResultList:[]           // 数组类型；订单编号
  5. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showPage({
  3.     url : '',
  4.     taokePid: '',
  5.     openType: 'auto'
  6. },function(ret, err){
  7.     if(ret.status){
  8.         alert(JSON.stringify(ret));
  9.     } else {
  10.         alert(JSON.stringify(err));
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showCartsPage

打开购物车

showCartsPage(callback(ret))

params

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式：拉起手淘和h5打开页面，默认值：auto
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status:true  // 布尔类型；返回交易状态
  3. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showCartsPage({
  3.     taokePid: '',
  4.     openType: 'auto'
  5. },function(ret, err){
  6.     if(ret.status){
  7.         alert(JSON.stringify(ret));
  8.     } else {
  9.         alert(JSON.stringify(err));
  10.     }
  11. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addItem2Cart

添加商品到购物车

addItem2Cart({params},callback(ret))

params

itemId：

  • 类型：字符串
  • 描述：商品id

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式,默认值：auto
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status:true  // 布尔类型；返回交易状态
  3. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.addItem2Cart({
  3.      itemId: '',
  4.     taokePid: '',
  5.     openType: 'auto'
  6. },function(ret, err){
  7.     if(ret.status){
  8.         alert(JSON.stringify(ret));
  9.     } else {
  10.         alert(JSON.stringify(err));
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showMyOrders

打开我的订单

showMyOrders({parmas})

params

isAllOrder:

  • 类型： 布尔
  • 描述： （可选）是否显示全部订单
  • 默认值： true

orderType:

  • 类型：数字
  • 描述：（可选）订单类型
  • 默认值： 0
  • 取值范围：
    • 0 (全部订单)
    • 1 (待付款订单)
    • 2 (待发货订单)
    • 3 (待收货订单)
    • 4 (待评价订单)

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式：拉起手淘和h5打开页面，默认值：auto，
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值,如果openType为h5，且交易成功，则有返回值
  1. {
  2.     status:true ,                // 布尔类型；返回交易状态
  3.     orderResultList:[]           // 数组类型；订单编号
  4. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showMyOrders({
  3.     orderType: 0,
  4.     isAllOrder: true,
  5.     taokePid: '',
  6.     openType: 'auto' 
  7. },function(ret, err){
  8.     if(ret.status){
  9.         alert(JSON.stringify(ret));
  10.     } else {
  11.         alert(JSON.stringify(err));
  12.     }
  13. });

可用性

Android系统, iOS系統

可提供的1.0.0及更高版本

showShopPage

打开店铺

showShopPage(param, callback(ret, err))

params

shopId：

  • 类型：字符

  • 描述：店铺id

taokePid:

  • 类型：（可选）字符串
  • 描述：淘客 pid （需登录阿里妈妈，实名认证后可获取 pid）

openType:

  • 类型：（可选）字符串
  • 描述：打开页面的方式：拉起手淘和h5打开页面，默认值：auto
  • 可选范围
    • auto //智能判断
    • native //手机淘宝
    • h5 // h5

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     status:true  // 布尔类型；返回交易状态
  3. }

err:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     code:0,      // 数字类型；错误码
  3.     msg:''       // 字符串；错误提示信息
  4. }

示例代码

  1. var aliTradePlus = api.require('aliTradePlus');
  2. aliTradePlus.showShopPage({
  3.     shopId: '60552065',
  4.     taokePid: '',
  5.     openType: 'auto' 
  6. },function(ret, err){
  7.     if(ret.status){
  8.         alert(JSON.stringify(ret));
  9.     } else {
  10.         alert(JSON.stringify(err));
  11.     }
  12. });

可用性

Android系统, iOS系統

可提供的1.0.0及更高版本