App Store Server Java Library

Use ReceiptUtility to extract a transactionId from a legacy App Receipt. Once you have the ID, you can use AppStoreServerAPIClient.getTransactionHistory to retrieve the full transaction history using the V2 API.

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.util.LinkedList;
import java.util.List;

// ... setup client ...
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);
}

Use PromotionalOfferSignatureCreator to generate signatures for promotional offers. This requires the encoded signing key, key ID, and bundle ID. You must provide the product ID, subscription offer ID, app account token, a unique nonce, and a timestamp.

import com.apple.itunes.storekit.offers.PromotionalOfferSignatureCreator;
import java.util.UUID;

// ... setup encodedKey, keyId, bundleId ...

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);

Use SignedDataVerifier to validate signed payloads (like App Store Server Notifications). You must provide a set of Apple Root CA InputStreams, the bundleId, and the Environment. If using the PRODUCTION environment, you must also provide the appAppleId.

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;

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; // Required for Production

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();
}

The AppStoreServerAPIClient is the primary entry point for interacting with the App Store Server APIs. It requires the encoded signing key, key ID, issuer ID, bundle ID, and the target Environment (e.g., Environment.SANDBOX or Environment.PRODUCTION).

import com.apple.itunes.storekit.client.AppStoreServerAPIClient;
import com.apple.itunes.storekit.model.Environment;
import com.apple.itunes.storekit.model.SendTestNotificationResponse;
import java.nio.file.Files;
import java.nio.file.Path;

// ... setup variables ...
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 (Exception e) {
    e.printStackTrace();
}