aliTrade

来自于：开发者

initSDK showLogin logout showItemDetailPage showPage showCartsPage addItem2Cart addTaoKeItem2Cart showMyOrders

概述

本模块已有升级版 aliTradePlus

aliTrade 封装了阿里百川电商sdk，能够使你的app快速集成淘宝的电商功能，包括授权登录，查看商品详情，查看购物车和商品支付等整个交易闭环，使用本模块需要遵从阿里百川的申请流程，需要登录阿里百川，进入控制台，创建应用并获取sdk的安全图片，此外该模块需要和 aliTradeAppendix（该模块为自定义模块）模块绑定使用，详细流程如下：

  1. 在阿里百川控制台创建应用：
    create_app

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

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

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

  4. 配置 ios 自定义模块 aliTradeAppendix：

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

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

  • 名称：aliTrade
  • 参数：appKey
  • 配置示例：
  1.   <!-- ios 配置方法 -->
  2.   <feature name="aliTrade">
  3.      <param name="appKey" value="23451169"/>
  4.      <param name="urlScheme" value="tbopen23451169"/>
  5.   </feature>

initSDK

初始化SDK

initSDK(callback(ret))

callback(ret, err)

ret:

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

err:

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showLogin

授权登录

showLogin(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回值
  1. {
  2.     nick : '',
  3.     avatarUrl : '',
  4.     id : '',
  5.     isLogin : true,
  6.     authorizationCode : '',
  7.     loginTime : '',
  8. }

err:

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

示例代码

  1. var aliTrade = api.require('aliTrade');
  2. aliTrade.showLogin(function(ret, err){
  3.     if(ret.status){
  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. }

err:

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showItemDetailPage

显示商品详情

showItemDetailPage({params},callback(ret))

params

itemId：

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

taokePid:

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

callback(ret)

ret:

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

err:

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showPage

唤起免登H5页面

showPage({params},callback(ret))

params

url：

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

callback(ret)

ret:

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

err:

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showCartsPage

唤起购物车

showCartsPage(callback(ret))

callback(ret)

ret:

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

err:

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addItem2Cart

添加商品到购物车

addItem2Cart({params},callback(ret))

params

title:

  • 类型：字符串
  • 描述：页面标题

itemId:

  • 类型：字符串
  • 描述：需要添加的商品id

callback(ret)

ret:

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

err:

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

示例代码

  1. var aliTrade = api.require('aliTrade');
  2. aliTrade.showPage({
  3.     title : '添加到购物车',
  4.     itemId : ''
  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及更高版本

addTaoKeItem2Cart

添加淘客商品到购物车

addTaoKeItem2Cart({params},callback(ret))

params

title:

  • 类型：字符串
  • 描述：页面标题

itemId:

  • 类型：字符串
  • 描述：需要添加的商品id

taokePid:

  • 类型：字符串
  • 描述：taokePid (需要到阿里妈妈获取)

callback(ret)

ret:

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

err:

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

示例代码

  1. var aliTrade = api.require('aliTrade');
  2. aliTrade.addTaoKeItem2Cart({
  3.     title : '添加到购物车',
  4.     itemId : '',
  5.     taokePid : ''
  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

orderType:

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

callback(ret)

ret:

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

err:

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

示例代码

  1. var aliTrade = api.require('aliTrade');
  2. aliTrade.showMyOrders({
  3.     orderType: 0
  4. },function(ret, err){
  5.     if(ret.status){
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

Android系统, iOS系統

可提供的1.0.0及更高版本