首页
/ IAPVerifier 技术文档

IAPVerifier 技术文档

2024-12-20 00:18:42作者:伍霜盼Ellen

本文档将详细介绍如何安装、使用以及调用 IAPVerifier 项目,帮助您理解和运用该 Node.js 库进行 iOS 应用内购买收据的验证。

1. 安装指南

IAPVerifier 可以通过 npm 进行安装:

npm install iap_verifier

该库不依赖于除 Node.js 之外的外部依赖。

2. 项目使用说明

IAPVerifier 接收一个 iOS 应用内购买收据的原始字符串,将其发送至 Apple 服务器进行验证,并返回一个表明收据是否有效的响应。

该库支持两种环境:沙盒(SandBox)和生产(Production)。您可以根据系统测试或生产运行的需求配置 IAPVerifier 使用相应的环境。

使用方法

在实例化验证器时,您需要提供应用的 iTunes 共享密钥,该密钥可在应用的 iTunes Connect 页面中的内购部分找到。

IAPVerifier API 非常简单,创建一个 IAPVerifier 实例并调用其 verifyReceipt 方法,提供一个回调函数。第一个参数是收据数据字符串,第二个参数是一个布尔值,指示收据数据是否已编码为 base64(此参数是可选的,默认为 false),最后一个参数是回调函数,包含三个参数。

verifyReceipt(rawReceipt, function(isValid, message, data){
  // 处理验证信息...
});

verifyAutoRenewReceipt 方法的使用方式类似。

verifyAutoRenewReceipt(rawReceipt, function(isValid, message, data){
  // 处理验证信息...
});

回调函数会返回以下三个参数:

  • isValid - 布尔值,指示收据是否有效或自动续订订阅是否激活
  • message - Apple 系统中与 statusCode 相关的消息
  • data - Apple 服务器返回的收据数据

示例代码

验证收据

JavaScript:

var IAPVerifier = require('iap_verifier');

// 验证一个收据
var receipt = 'raw_receipt_data_from_ios';

var client = new IAPVerifier(itunes_shared_secret);
client.verifyReceipt(receipt, function(valid, msg, data) {
  if (valid) {
    // 在系统中更新支付状态
    console.log("有效的收据");
  } else {
    console.log("无效的收据");
  }
});

CoffeeScript:

IAPVerifier = require('iap_verifier')

# 验证一个收据
receipt = 'raw_receipt_data_from_ios'

client = new IAPVerifier(itunes_shared_secret)
client.verifyReceipt receipt, (valid, msg, data) ->
  if valid
    console.log("有效的收据")
  else
    console.log("无效的收据")

验证自动续订收据

JavaScript:

// 验证一个自动续订收据
var receipt = 'raw_receipt_data_from_ios';

var client = new IAPVerifier('your_secret_key_from_itunes')
client.verifyAutoRenewReceipt(receipt, function(valid, msg, data){
  if(valid) {
    // 在系统中更新支付状态
  }
});

CoffeeScript:

# 验证一个自动续订收据
receipt = 'raw_receipt_data_from_ios'

client = new IAPVerifier('your_secret_key_from_itunes')
client.verifyAutoRenewReceipt receipt, (valid, msg, data) ->
  if valid
    console.log("有效的收据")
  else
    console.log("无效的收据")

特别说明:应用商店审核

在应用审核期间有一个特殊情况,即 Apple 使用发行(生产)版本的应用进行测试,但为了测试目的,他们使用 DNS 来欺骗应用,使其认为正在访问生产服务器,实际上却在处理内购时访问沙盒服务器。

这意味着在审核期间验证收据时,您必须回退到沙盒环境检查收据。IAPVerifier 会自动通过检查 Apple 服务器返回的错误代码,并在将沙盒收据发送到生产环境时重新尝试在沙盒环境中进行验证。这是 Apple 推荐的最简单的方法来处理应用商店审核收据。

3. 项目 API 使用文档

IAPVerifier 提供以下 API 方法:

  • verifyReceipt(rawReceipt, callback) - 验证收据
  • verifyAutoRenewReceipt(rawReceipt, callback) - 验证自动续订收据

其中 rawReceipt 是收据的原始数据字符串,callback 是一个回调函数,包含三个参数:isValidmessagedata

4. 项目安装方式

项目安装方式请参考本文档的“安装指南”部分,即使用 npm 进行安装:

npm install iap_verifier
登录后查看全文
热门项目推荐