app store server library java

Java-Bibliothek des Apple App Store Servers

Die Java-Serverbibliothek für die App Store Server-API und App Store Server-Benachrichtigungen. Auch in Swift, Python und Node.js verfügbar.

Inhaltsverzeichnis

1. Installation
2. Dokumentation
3. Verwendung
4. Unterstützung

Installation

Anforderungen

• Java 11+

Gradle

implementation ' com.apple.itunes.storekit:app-store-server-library:3.2.0 '

Maven

< dependency >
    < groupId >com.apple.itunes.storekitgroupId >
    < artifactId >app-store-server-libraryartifactId >
    < version >3.2.0version >
dependency >

Dokumentation

JavaDocs

WWDC-Video

Erhalten eines In-App-Kaufschlüssels von App Store Connect

Um die App Store Server-API zu verwenden oder Signaturen für Werbeangebote zu erstellen, ist ein von App Store Connect heruntergeladener Signaturschlüssel erforderlich. Um diesen Schlüssel zu erhalten, müssen Sie über die Administratorrolle verfügen. Gehen Sie zu Benutzer und Zugriff > Integrationen > In-App-Kauf. Hier können Sie Schlüssel erstellen und verwalten sowie Ihre Aussteller-ID finden. Wenn Sie einen Schlüssel verwenden, benötigen Sie auch die Schlüssel-ID und die Aussteller-ID.

Erhalten von Apple-Stammzertifikaten

Laden Sie die Stammzertifikate herunter, die Sie im Abschnitt „Apple-Stammzertifikate“ der Apple-PKI-Site finden, und speichern Sie sie. Stellen Sie diese Zertifikate als Array einem SignedDataVerifier zur Verfügung, um zu überprüfen, ob die signierten Daten von Apple stammen.

Verwendung

API-Nutzung

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

Verifizierungsnutzung

 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 must be provided for the Production environment

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

Belegverwendung

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

Signaturerstellung für Werbeangebote

 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 = "" ;
        String subscriptionOfferId = "" ;
        String appAccountToken = "" ;
        UUID nonce = UUID . randomUUID ();
        long timestamp = System . currentTimeMillis ();
        String encodedSignature = signatureCreator . createSignature ( productId , subscriptionOfferId , appAccountToken , nonce , timestamp );
        System . out . println ( encodedSignature );
    }
}

Unterstützung

Nur die neueste Hauptversion der Bibliothek erhält Updates, einschließlich Sicherheitsupdates. Daher wird empfohlen, auf neue Hauptversionen zu aktualisieren.