Apple App Store 服务器 Java 库
这是用于 App Store Server API 和 App Store 服务器通知 的 Java 服务器库。同时也提供 Swift、Python 和 Node.js 版本。
目录
安装
要求
- Java 11+
Gradle
implementation 'com.apple.itunes.storekit:app-store-server-library:3.1.0'
Maven
<dependency>
<groupId>com.apple.itunes.storekit</groupId>
<artifactId>app-store-server-library</artifactId>
<version>3.1.0</version>
</dependency>
文档
从 App Store Connect 获取应用内购买密钥
要使用 App Store Server API 或创建促销优惠签名,需要从 App Store Connect 下载签名密钥。要获取此密钥,您必须拥有管理员角色。请前往"用户和访问">"集成">"应用内购买"。在这里,您可以创建和管理密钥,以及找到您的发行者 ID。使用密钥时,您还需要密钥 ID 和发行者 ID。
获取 Apple 根证书
从 Apple PKI 网站的 Apple 根证书部分下载并存储根证书。将这些证书作为数组提供给 SignedDataVerifier,以验证签名数据是否来自 Apple。
使用方法
API 使用示例
import com.apple.itunes.storekit.client.APIException;
import com.apple.itunes.storekit.client.AppStoreServerAPIClient;
import com.apple.itunes.storekit.model.Environment;
import com.apple.itunes.storekit.model.SendTestNotificationResponse;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
public class APIExample {
public static void main(String[] args) throws Exception {
String issuerId = "99b16628-15e4-4668-972b-eeff55eeff55";
String keyId = "ABCDEFGHIJ";
String bundleId = "com.example";
Path filePath = Path.of("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8");
String encodedKey = Files.readString(filePath);
Environment environment = Environment.SANDBOX;
AppStoreServerAPIClient client =
new AppStoreServerAPIClient(encodedKey, keyId, issuerId, bundleId, environment);
try {
SendTestNotificationResponse response = client.requestTestNotification();
System.out.println(response);
} catch (APIException | IOException e) {
e.printStackTrace();
}
}
}
验证使用示例
import com.apple.itunes.storekit.model.Environment;
import com.apple.itunes.storekit.model.ResponseBodyV2DecodedPayload;
import com.apple.itunes.storekit.verification.SignedDataVerifier;
import com.apple.itunes.storekit.verification.VerificationException;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.Set;
public class ExampleVerification {
public static void main(String[] args) {
String bundleId = "com.example";
Environment environment = Environment.SANDBOX;
Set<InputStream> rootCAs = Set.of(
new FileInputStream("/path/to/rootCA1"),
new FileInputStream("/path/to/rootCA2")
);
Long appAppleId = null; // 生产环境必须提供 appAppleId
SignedDataVerifier signedPayloadVerifier = new SignedDataVerifier(rootCAs, bundleId, appAppleId, environment, true);
String notificationPayload = "ey...";
try {
ResponseBodyV2DecodedPayload payload = signedPayloadVerifier.verifyAndDecodeNotification(notificationPayload);
System.out.println(payload);
} catch (VerificationException e) {
e.printStackTrace();
}
}
}
收据使用示例
import com.apple.itunes.storekit.client.AppStoreServerAPIClient;
import com.apple.itunes.storekit.client.GetTransactionHistoryVersion;
import com.apple.itunes.storekit.migration.ReceiptUtility;
import com.apple.itunes.storekit.model.Environment;
import com.apple.itunes.storekit.model.HistoryResponse;
import com.apple.itunes.storekit.model.TransactionHistoryRequest;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.LinkedList;
import java.util.List;
public class ExampleMigration {
public static void main(String[] args) throws Exception {
String issuerId = "99b16628-15e4-4668-972b-eeff55eeff55";
String keyId = "ABCDEFGHIJ";
String bundleId = "com.example";
Path filePath = Path.of("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8");
String encodedKey = Files.readString(filePath);
Environment environment = Environment.SANDBOX;
AppStoreServerAPIClient client =
new AppStoreServerAPIClient(encodedKey, keyId, issuerId, bundleId, environment);
String appReceipt = "MI...";
ReceiptUtility receiptUtil = new ReceiptUtility();
String transactionId = receiptUtil.extractTransactionIdFromAppReceipt(appReceipt);
if (transactionId != null) {
TransactionHistoryRequest request = new TransactionHistoryRequest()
.sort(TransactionHistoryRequest.Order.ASCENDING)
.revoked(false)
.productTypes(List.of(TransactionHistoryRequest.ProductType.AUTO_RENEWABLE));
HistoryResponse response = null;
List<String> transactions = new LinkedList<>();
do {
String revision = response != null ? response.getRevision() : null;
response = client.getTransactionHistory(transactionId, revision, request, GetTransactionHistoryVersion.V2);
transactions.addAll(response.getSignedTransactions());
} while (response.getHasMore());
System.out.println(transactions);
}
}
}
促销优惠签名创建
import com.apple.itunes.storekit.offers.PromotionalOfferSignatureCreator;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.UUID;
public class ExampleSignatureCreation {
public static void main(String[] args) throws Exception {
String keyId = "ABCDEFGHIJ";
String bundleId = "com.example";
Path filePath = Path.of("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8");
String encodedKey = Files.readString(filePath);
PromotionalOfferSignatureCreator signatureCreator = new PromotionalOfferSignatureCreator(encodedKey, keyId, bundleId);
String productId = "<product_id>";
String subscriptionOfferId = "<subscription_offer_id>";
String appAccountToken = "<app_account_token>";
UUID nonce = UUID.randomUUID();
long timestamp = System.currentTimeMillis();
String encodedSignature = signatureCreator.createSignature(productId, subscriptionOfferId, appAccountToken, nonce, timestamp);
System.out.println(encodedSignature);
}
}
支持
只有最新的主要版本库会收到更新,包括安全更新。因此,建议更新到新的主要版本。