Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - apple/app-store-server-library-python: The Python server library for the App Store Server API and App Store Server Notifications. · GitHub
Skip to content

Repository files navigation

Apple App Store Server Python Library

The Python server library for the App Store Server API, App Store Server Notifications, Retention Messaging API, and Advanced Commerce API. Also available in Swift, Node.js, and Java.

Table of Contents

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

Installation

Requirements

  • Python 3.8+

pip

pip install app-store-server-library

Documentation

Documentation

WWDC Video

Obtaining an In-App Purchase key from App Store Connect

To use the App Store Server API or create promotional offer signatures, a signing key downloaded from App Store Connect is required. To obtain this key, you must have the Admin role. Go to Users and Access > Integrations > In-App Purchase. Here you can create and manage keys, as well as find your issuer ID. When using a key, you'll need the key ID and issuer ID as well.

Obtaining Apple Root Certificates

Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.

Usage

API Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=client.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)

Verification Usage

fromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.signed_data_verifierimportVerificationException, SignedDataVerifierroot_certificates=load_root_certificates()
enable_online_checks=Truebundle_id="com.example"environment=Environment.SANDBOXapp_apple_id=None# appAppleId must be provided for the Production environmentsigned_data_verifier=SignedDataVerifier(root_certificates, enable_online_checks, environment, bundle_id, app_apple_id)
try: signed_notification="ey.."payload=signed_data_verifier.verify_and_decode_notification(signed_notification)
print(payload)
exceptVerificationExceptionase:
print(e)

Receipt Usage

fromappstoreserverlibrary.api_clientimportAppStoreServerAPIClient, APIException, GetTransactionHistoryVersionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentfromappstoreserverlibrary.receipt_utilityimportReceiptUtilityfromappstoreserverlibrary.models.HistoryResponseimportHistoryResponsefromappstoreserverlibrary.models.TransactionHistoryRequestimportTransactionHistoryRequest, ProductType, Orderprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
receipt_util=ReceiptUtility()
app_receipt="MI.."try: transaction_id=receipt_util.extract_transaction_id_from_app_receipt(app_receipt)
iftransaction_id!=None:
transactions= []
response: HistoryResponse=Nonerequest: TransactionHistoryRequest=TransactionHistoryRequest(
sort=Order.ASCENDING,
revoked=False,
productTypes=[ProductType.AUTO_RENEWABLE]
)
whileresponse==Noneorresponse.hasMore:
revision=response.revisionifresponse!=NoneelseNoneresponse=client.get_transaction_history(transaction_id, revision, request, GetTransactionHistoryVersion.V2)
fortransactioninresponse.signedTransactions:
transactions.append(transaction)
print(transactions)
exceptAPIExceptionase:
print(e)

Promotional Offer Signature Creation

fromappstoreserverlibrary.promotional_offerimportPromotionalOfferSignatureCreatorimporttimeprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"bundle_id="com.example"promotion_code_signature_generator=PromotionalOfferSignatureCreator(private_key, key_id, bundle_id)
product_id="<product_id>"subscription_offer_id="<subscription_offer_id>"application_username="<application_username>"nonce="<nonce>"timestamp=round(time.time()*1000)
base64_encoded_signature=promotion_code_signature_generator.create_signature(product_id, subscription_offer_id, application_username, nonce, timestamp)

Async HTTPX Support

Pip

Include the optional async dependency

pip install app-store-server-library[async]

API Usage

fromappstoreserverlibrary.api_clientimportAsyncAppStoreServerAPIClient, APIExceptionfromappstoreserverlibrary.models.EnvironmentimportEnvironmentprivate_key=read_private_key("/path/to/key/SubscriptionKey_ABCDEFGHIJ.p8") # Implementation will varykey_id="ABCDEFGHIJ"issuer_id="99b16628-15e4-4668-972b-eeff55eeff55"bundle_id="com.example"environment=Environment.SANDBOXclient=AsyncAppStoreServerAPIClient(private_key, key_id, issuer_id, bundle_id, environment)
try: response=awaitclient.request_test_notification()
print(response)
exceptAPIExceptionase:
print(e)
# Once client use is finishedawaitclient.async_close()

Support

Only the latest major version of the library will receive updates, including security updates. Therefore, it is recommended to update to new major versions.

About

The Python server library for the App Store Server API and App Store Server Notifications.

Resources

Code of conduct

Contributing

Security policy

Stars

264 stars

Watchers

21 watching

Forks

Releases

Used by

Contributors

Languages