app store server library java

Bibliothèque Java du serveur Apple App Store

La bibliothèque du serveur Java pour l'API du serveur App Store et les notifications du serveur App Store. Également disponible en Swift, Python et Node.js.

Table des matières

1. Installation
2. Documentation
3. Usage
4. Soutien

Installation

Exigences

• Java11+

Graduation

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 >

Documentation

JavaDocs

Vidéo WWDC

Obtention d'une clé d'achat In-App depuis App Store Connect

Pour utiliser l'API App Store Server ou créer des signatures d'offres promotionnelles, une clé de signature téléchargée depuis App Store Connect est requise. Pour obtenir cette clé, vous devez disposer du rôle Administrateur. Accédez à Utilisateurs et accès > Intégrations > Achat intégré. Ici, vous pouvez créer et gérer des clés, ainsi que trouver votre identifiant d'émetteur. Lorsque vous utilisez une clé, vous aurez également besoin de l'ID de la clé et de l'ID de l'émetteur.

Obtention des certificats racine Apple

Téléchargez et stockez les certificats racine trouvés dans la section Certificats racine Apple du site Apple PKI. Fournissez ces certificats sous forme de tableau à un SignedDataVerifier pour permettre de vérifier que les données signées proviennent d'Apple.

Usage

Utilisation de l'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 ();
        }
    }
}

Utilisation de la vérification

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

Utilisation des reçus

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

Création de signature d'offre promotionnelle

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

Soutien

Seule la dernière version majeure de la bibliothèque recevra des mises à jour, y compris des mises à jour de sécurité. Par conséquent, il est recommandé de mettre à jour vers les nouvelles versions majeures.