Skip to content

Latest commit

 

History

History
672 lines (451 loc) · 11.7 KB

alibaichuan_v1.0.2.md

File metadata and controls

672 lines (451 loc) · 11.7 KB
Raw

##Description: alibaichuan

##概述

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

使用须知

1、此模块依賴安全图片模块，安全圖片是阿里的一種身份認證機制，每個證書(或者bundle:iOS包名)對應一個安全圖片，測試時候我們均使用平臺默認的證書，打包时選擇测试版

2、首先，去GITHUB下载Custom Module模块，导入到自定义模块，(android和iOS兩個<而且iOS的雲編譯和自定義loader所用的還不一樣>)

3、使用步骤参考接入指南

#initTaeSDK

初始化模块信息，打开页面require完成就去执行

initTaeSDK(param, function(ret, err))

##params

isvcode：

  • 类型：字符串
  • 默认值：无
  • 描述：自定义ISVCode,用于服务器订单跟踪。(如果服务器不做处理，可以随便传)

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //初始化成功信息
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 1000                     //错误码
    message:"user is not exist"     //错误描述
}

##示例代码

var alibaichuan = null;
apiready = function() {
    alibaichuan = api.require('alibaichuan');
    initSDK();
};
var param = {
    isvcode : "feelinglife"
};
function initSDK() {
    alibaichuan.initTaeSDK(param,function(ret, err) {
        if (ret) {
            alert(JSON.stringify(ret));
        } else {
            alert(JSON.stringify(err));
        }
    });
}

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.2及更高版本
#**showLogin** 
打开手淘授权登陆

showLogin(function(ret, err))

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    userNick:"rocke"                //用户昵称
    avatarUrl:"http://..."          //用户头像
    authCode:"2mp9..."              //授权码
    loginTime:"1449932770044s"      //登陆时间
    otherInfo:""                    //其他
    userId:"AAE..."                 //用户ID
    isLogin:true                    //是否登陆，true/false
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 1000                     //错误码
    message:"user is not exist"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
alibaichuan.showLogin(function(ret, err) {
    if (ret) {
        alert("登录success:" + JSON.stringify(ret));
    } else {
        alert("登录error:" + JSON.stringify(ret));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**getUserInfo** 
获取已经登陆的用户的相关信息

getUserInfo(function(ret, err))

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    userNick:"rocke"                //用户昵称
    avatarUrl:"http://..."          //用户头像
    authCode:"2mp9..."              //授权码
    loginTime:"1449932770044s"      //登陆时间
    otherInfo:""                    //其他
    userId:"AAE..."                 //用户ID
    isLogin:true                    //是否登陆，true/false
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90000                //错误码
    message:"Not logged in"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
alibaichuan.getUserInfo(function(ret, err) {
    if (ret) {
        alert("用户信息 ret - " + JSON.stringify(ret));
    } else {
        alert("用户信息 err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**logout** 
退出登陆

logout(function(ret, err))

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90000                //错误码
    message:"Not logged in"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
alibaichuan.logout(function(ret, err) {
    if (ret) {
        alert("ret - " + JSON.stringify(ret));
    } else {
        alert("err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**openMyCart** 
打开我的购物车

openMyCart(param, function(ret, err))

##params

isvcode：

  • 类型：字符串
  • 默认值：无
  • 描述：自定义ISVCode,用于服务器订单跟踪。(如果服务器不做处理，可以随便传)

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90000                //错误码
    message:"Not logged in"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
var param = {
    isvcode : "feelinglife"
};
alibaichuan.openMyCart(param, function(ret, err) {
    if (ret) {
        alert("ret - " + JSON.stringify(ret));
    } else {
        alert("err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**myOrdersPage** 
打开我的订单

myOrdersPage(function(ret, err))

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90000                //错误码
    message:"Not logged in"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
alibaichuan.myOrdersPage(function(ret, err) {
    if (ret) {
        alert("ret - " + JSON.stringify(ret));
    } else {
        alert("err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**showTaokeItemById** 
通过itemid打开宝贝

showTaokeItemById({params}, function(ret, err))

##params

isvcode：

  • 类型：字符串
  • 默认值：无
  • 描述：自定义ISVCode,用于服务器订单跟踪。(如果服务器不做处理，可以随便传)

itemid：

mmpid：

  • 类型：字符串
  • 默认值：无
  • 描述：阿里妈妈的pid，如果你还没有开通 阿里妈妈-淘宝联盟账号，要去阿里妈妈开通账号并且补全账号信息以及绑定支付宝, 因为分销的商品最后是返回到阿里妈妈的账号，并通过支付宝提现拿到的

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90001                    //错误码
    message:"Parameter is null"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
var param = {
    isvcode : "feelinglife",
    itemid : "522997347023", //或openid:AAHd5d-HAAeGwJedwSnHktBI
    mmpid : "mm_14421418_0_0"
};
alibaichuan.showTaokeItemById(param, function(ret, err) {
    if (ret) {
        alert("ret - " + JSON.stringify(ret));
    } else {
        alert("err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**showTaokeItemByOpenId** 
1.0.5之后此接口可以用showTaokeItemById接口代替

打开我的订单

showTaokeItemById({params}, function(ret, err))

##params

openid：

  • 类型：字符串
  • 默认值：无
  • 描述：商品openId，eg.AAHd5d-HAAeGwJedwSnHktBI

mmpid：

  • 类型：字符串
  • 默认值：无
  • 描述：阿里妈妈的pid，如果你还没有开通 阿里妈妈-淘宝联盟账号，要去阿里妈妈开通账号并且补全账号信息以及绑定支付宝, 因为分销的商品最后是返回到阿里妈妈的账号，并通过支付宝提现拿到的

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90001                    //错误码
    message:"Parameter is null"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
var param = {
    openid : "AAGMLk9FACJvEVXfLXXUtbjt",
    mmpid : "mm_14421418_0_0"
};
alibaichuan.showTaokeItemByOpenId(param, function(ret, err) {
    if (ret) {
        alert("ret - " + JSON.stringify(ret));
    } else {
        alert("err - " + JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统, iOS系統

可提供的1.0.0及更高版本
#**showDetailByURL** 
通过URL打开宝贝详情

showDetailByURL({params}, function(ret, err))

##params

url：

  • 类型：字符串
  • 默认值：无
  • 描述：商品URL地址

mmpid：

  • 类型：字符串
  • 默认值：无
  • 描述：阿里妈妈的pid，如果你还没有开通 阿里妈妈-淘宝联盟账号，要去阿里妈妈开通账号并且补全账号信息以及绑定支付宝, 因为分销的商品最后是返回到阿里妈妈的账号，并通过支付宝提现拿到的

##callback(ret,err)

ret：

  • 类型：JSON对象

内部字段：

{
    code : 0              //正确码
    message:"success"     //描述
}

err：

  • 类型：JSON对象

内部字段：

{
    code : 90001                    //错误码
    message:"Parameter is null"     //错误描述
}

##示例代码

var alibaichuan = api.require('alibaichuan');
var param = {
    url : "https://detail.tmall.com/item.htm?id=528887107325",
    mmpid : "mm_14421418_0_0"
};
alibaichuan.showDetailByURL(param, function(ret, err) {
    if (ret) {
        setinnerHTML(JSON.stringify(ret));
    } else {
        setinnerHTML(JSON.stringify(err));
    }
});

##补充说明

无

##可用性

Android系统，iOS系统

可提供的1.0.3及更高版本
#**错误码**

  1. 0 请求成功

  2. 90000 用户未登陆

  3. 90001 参数为空

  4. 其他，阿里返回的code和错误提示