7 uap mobile api referenceuap_plug_api-1

1、uexInAppPurchase1、简介 2、API概览 3、更新历史 1简介内部支付(IAP)插件 1.1 说明封装内部支付(IAP)相关操作 1.2 UI展示1.3 公告iOS开发的收入有三种来源:出售应用内购和广告.国内用户通常很少直接购买应用,因此对于开发者而言(特别是个人开发者),内购和广 告收入就成了主要的收入来源.内购营销模式,通常软件本身是不收费的,但是要获得某些 就必须购买一些道具,需要通过内购的方式 来实现,而内购的过程是由苹果官方统一来管理的.1.4 开源源码插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)1.5 平台版本支持本插件的

2、所有API默认只支持iOS7.0+操作系统,不支持Android. 有特殊版本要求的API会在文档中额外说明.1.6 接口有效性本插件所有API默认在插件版本4.0.0+可用.在后续版本中新添加的接口会在文档中额外说明.2 API概览2.1方法 getProductList /获取有效的产品列表uexInAppPurchase.getProductList(params,callback);说明:该方法从苹果服务器返回有效产品信息,包括产品描述信息参考名称价格产品ID, 参数:参数名称参数类型是否必选说明paramObject是接口所需数据,形式见下:callbackFunction是回调方法

3、 var params = productIDs:getProductListcanMakePaypurchaserestorePurchase onTransactionStateonRestoreState参数名称参数类型是否必选说明productIDsArray在苹果官网内购项目中填写的产品ID是回调参数:var callback = function (error,data)参数名称类型说明errorNumber0表示成功,非0表示失败dataString从苹果服务器获取的有效产品信息,格式如下:var data = productIdentifier:, localizedTitle

4、:, price:, localizedDescription.各字段含义如下:参数是否必须说明productIdentifier产品ID是localizedTitle是参考名称price是价格等级localizedDescription是产品描述信息示例:var params = productIDs: EnergyBottle,GoldenGlobe,ProtectiveGloves;uexInAppPurchase.getProductList(params,function(error,data) if(!erro r)alert(JSON.stringify(data);); can

5、MakePay /测试设备是否支持支付功能var result = uexInAppPurchase.canMakePay();说明:该方法测试设备是否支持支付功能,支持同步返回.参数无返回值参数名称参数类型是否必选说明是 是否必选resultNumber0表示设备允许内购,1设备禁止内购参数名称参数类型说明示例:var result = uexInAppPurchase.canMakePay();alert(result); purchase /购一产品uexInAppPurchase.purchase(params);说明:调用此方法前,必须先调用getProductList获得要购买的产

6、品 该产品可以是消耗品或非消耗品以及其它类型,开发人员应对非消耗品进行逻辑处理,非消耗品无需再次购买.参数:参数名称参数类型是否必选说明paramObject接口所需数据,形式见下:是callbackFunction是回调方法var params = productID: , quantity: , verifyStrategy:参数类型是否必选参数名称说明productIDString某一产品ID,通过GetProductList获取 是quantity购买的数量,默认为1Numbe r否verifyStrat egyNumbe r0 - 购买完成后进行验证(沙盒环境); 1- 购买完成后进

7、行验证(生产环境) ; 2 - 不进行验证,直接返回订单验证数据;默认为0否verifyStrategy /原appStoreVerifyURL参数废弃 由于考虑到用户在支付订单后可能存在的退款行为,建议用户采用验证策略2,并将订单验证数据上传至App并返回给前端验证结果.,由进行验证操作 App可以保留此份验证数据,并在需要时进行再次验证,获取订单的最新情况.验证方法可以参考Apple官方文档var callback = function(error,data)参数名称是否必选参数类型说明errorNumber0 表示购买成功 其他非0值均表示购买失败 详见下方说明 是dataObject/

8、Strin gerror为0时为Object类型,为订单数据 详见下方说明; error非0时为String类型,表示错误信息 是error错误码信息0verifyStrategy为0或者1时 表示购买成功且验证请求成功 verifystrategy为2时,表示购买成功 1productID对应的产品未找到 2购买过程发生错误 3购买成功,但验证过程发生错误,仅verifyStrategy为0或者1会发生此错误 购买成功时的订单数据 verifyStrategy为0或者1时,data为Apple服务器的返回数据,具体字段说明详见Apple官方文档verifyStrategy为2时,data结构

9、如下 var data = receiptData:,/String 订单验证数据,base64-encoded字符串transactionDate:,/String 交易时间transactionIdentifier:,/String AppStore分配的交易唯一标识符productIdentifier:,/String 订单内的产品唯一标识符quantity:,/Number 订单内的产品数量 示例:var params = productID: EnergyBottle, quantity:2, verifyStrategy: 2;uexInAppPurchase.purchase(p

10、arams,function(error,data) if(error)alert(purchase error! code: + error + nmessage: + data);elsealert(purchase success! data: + JSON.stringify(data););restorePurchase /恢复购买方法uexInAppPurchase.restorePurchase();说明:恢复所有非消耗品,对于非消耗品,用户在完成购买后如果使用其他机器登录或者卸载重新安装应用后通常希望这些非消耗品能够恢复.参数:无示例:uexInAppPurchase.rest

11、orePurchase();2.1方法 onRequestState /对发送产品请求进行uexInAppPurchase.onRequestState(result)说明:当向苹果服务器发送请求获取有效产品信息时,对getProductList方法中发送请求的状态进行 参数:参数名称参数类型是否必选说明resultString形式见下:是var result= status:, errorCode:, errorDescription参数名称参数类型是否必选说明statusNumber发送产品请求的状态,0表示请求完成,1表示请求失败 是errorCodeNumberstatus为1才有,错

12、误状态码 否errorDescriptionStringstatus为1才有,错误状态的描述信息 否示例:function onRequestState(result) alert(result);window.uexOnload =function() uexInAppPurchase.onRequestState = onRequestState; onPurchaseState /对产品购买状态的方法uexInAppPurchase.onPurchaseState(result)说明:当进行购买动作时,要对购买的产品的有效性进行判断,即对purchase方法中产品信息的有效性进行参数:参

13、数名称参数类型是否必选说明resultString形式见下:是var result= status:, msg:参数名称参数类型是否必选说明statusNumber购买产品的有效性,0表示产品有效,1表示产品无效是msgString产品有效返回purchase start,产品无效返回product is nil是示例:function onPurchaseState(result) alert(result);window.uexOnload =function() uexInAppPurchase.onPurchaseState = onPurchaseState; onTransacti

14、onState /对产品交易状态和信息的方法uexInAppPurchase.onTransactionState(result)说明:当购买的产品为有效产品时,会将有效产品加入支付队列就形成一次购买请求,并且用户允许内购时,将会进行交易.该方法是对用户交易 状态的.参数:参数名称参数类型是否必选说明resultString形式见下:是var result =/status为0receipt: ,/交易成功的详细信息/status为1transactionDate: ,/String,交易日期transactionIdentifier ,/String,交易标识符originalTransac

15、tion ,/json,原始交易信息productIdentifier ,/String,购买的产品ID quantity ,/Number,购买产品数量 /status为2或3errorCode , /Number,错误标识码errorDescription ,/String,错误的描述信息productIdentifier,/String, 购买的产品ID/status为4msg: ,/返回responseData is nil参数名称参数类型是否必选说明statusNumber交易状态标识符,详细说明见下 是status字段含义如下:value说明0通过验证,购买成功1恢复成功2购买失败

16、3验证购买过程中发生错误 4验证购买过程中返回数据为空 示例:window.uexOnload =function() uexInAppPurchase.onTransactionState = function(result)alert(result); onRestoreState /对产品恢复购买的状态进行uexInAppPurchase.onRestoreState(result)说明:对于非消耗品,用户在完成购买后如果使用其他机器登录或者卸载重新安装应用后通常希望这些非消耗品能够恢复,该方法是对 restorePurchase方法进行,返回恢复购买的状态.参数:参数名称参数类型是否必选说明resultString形式见下:是var result= status:, errorCode:, errorDescription参数名称参数类型是否必选说明statusNumber恢复购买的状态,0表示恢复购买完成,1表示恢复购买失败 是errorCodeNumberstatus为1才有,错误状态码 否errorDescriptionStringstatus为1才有,错误状态的描述信息 否示例:function onRestoreState(result) alert(result