InAppPy

Table of contents

1. Introduction

2. Installation

3. Google Play (validates receipt against provided signature using RSA)

frominapppyimportGooglePlayValidator,InAppPyValidationErrorbundle_id='com.yourcompany.yourapp'api_key='API key from the developer console'validator=GooglePlayValidator(bundle_id,api_key)try:# receipt means `androidData` in result of purchase# signature means `signatureAndroid` in result of purchasevalidation_result=validator.validate('receipt','signature')exceptInAppPyValidationError:# handle validation errorpass

importjsonfrominapppyimportGooglePlayValidator,InAppPyValidationErrorbundle_id='com.yourcompany.yourapp'# Avoid hard-coding credential data in your code. This is just an example.api_credentials=json.loads('{''   "type": "service_account",''   "project_id": "xxxxxxx",''   "private_key_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",''   "private_key": "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\n-----END PRIVATE KEY-----\n",''   "client_email": "XXXXXXXXX@XXXXXXXX.XXX",''   "client_id": "XXXXXXXXXXXXXXXXXX",''   "auth_uri": "https://accounts.google.com/o/oauth2/auth",''   "token_uri": "https://oauth2.googleapis.com/token",''   "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",''   "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXXXXX.iam.gserviceaccount.com"'' }')validator=GooglePlayValidator(bundle_id,api_credentials)try:# receipt means `androidData` in result of purchase# signature means `signatureAndroid` in result of purchasevalidation_result=validator.validate('receipt','signature')exceptInAppPyValidationError:# handle validation errorpass

4. Google Play verification

Setting up Google Service Account Credentials

{"type":"service_account","project_id":"your-project-id","private_key_id":"a1b2c3d4e5f6...","private_key":"-----BEGIN PRIVATE KEY-----\nYourPrivateKeyHere\n-----END PRIVATE KEY-----\n","client_email":"your-service-account@your-project.iam.gserviceaccount.com","client_id":"123456789","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/..."}

Usage Example (with file path)

frominapppyimportGooglePlayVerifier,errorsdefgoogle_validator(receipt):"""    Accepts receipt, validates in Google.    """purchase_token=receipt['purchaseToken']product_sku=receipt['productId']# Pass the path to your service account JSON key fileverifier=GooglePlayVerifier(GOOGLE_BUNDLE_ID,'/path/to/your-service-account-key.json',# Path to the JSON key file    )response= {'valid':False,'transactions': []}try:result=verifier.verify(purchase_token,product_sku,is_subscription=True        )response['valid']=Trueresponse['transactions'].append(            (result['orderId'],product_sku)        )excepterrors.GoogleErrorasexc:logging.error('Purchase validation failed {}'.format(exc))returnresponse

Usage Example (with credentials dictionary)

importjsonfrominapppyimportGooglePlayVerifier,errorsdefgoogle_validator(receipt):"""    Accepts receipt, validates in Google using dict credentials.    """purchase_token=receipt['purchaseToken']product_sku=receipt['productId']# Load credentials from environment variable or secure storage# NEVER hard-code credentials in your source code!credentials_json=os.environ.get('GOOGLE_SERVICE_ACCOUNT_JSON')credentials_dict=json.loads(credentials_json)# Pass the credentials as a dictionaryverifier=GooglePlayVerifier(GOOGLE_BUNDLE_ID,credentials_dict,# Dictionary containing the JSON key data    )response= {'valid':False,'transactions': []}try:result=verifier.verify(purchase_token,product_sku,is_subscription=True        )response['valid']=Trueresponse['transactions'].append(            (result['orderId'],product_sku)        )excepterrors.GoogleErrorasexc:logging.error('Purchase validation failed {}'.format(exc))returnresponse

5. Google Play verification (with result)

frominapppyimportGooglePlayVerifier,errorsdefgoogle_validator(receipt):"""    Accepts receipt, validates in Google.    """purchase_token=receipt['purchaseToken']product_sku=receipt['productId']# Use the service account credentials (see section 4 for setup)verifier=GooglePlayVerifier(GOOGLE_BUNDLE_ID,GOOGLE_SERVICE_ACCOUNT_KEY_FILE,# Path to JSON key file or dict    )response= {'valid':False,'transactions': []}result=verifier.verify_with_result(purchase_token,product_sku,is_subscription=True    )# result contains dataraw_response=result.raw_responseis_canceled=result.is_canceledis_expired=result.is_expiredreturnresult

6. Google Play (consuming products)

frominapppyimportGooglePlayVerifier,errorsdefconsume_purchase(receipt):"""    Consume a purchase after validation.    """purchase_token=receipt['purchaseToken']product_sku=receipt['productId']# Use the service account credentials (see section 4 for setup)verifier=GooglePlayVerifier(GOOGLE_BUNDLE_ID,GOOGLE_SERVICE_ACCOUNT_KEY_FILE,# Path to JSON key file or dict    )try:# First verify the purchaseverification_result=verifier.verify(purchase_token,product_sku,is_subscription=False        )# Then consume it to prevent refundsconsume_result=verifier.consume_product(purchase_token,product_sku        )return {'success':True,'consumed':True}excepterrors.GoogleErrorasexc:logging.error('Purchase consumption failed {}'.format(exc))return {'success':False,'error':str(exc)}

7. App Store (validates receipt using optional shared-secret against iTunes service)

frominapppyimportAppStoreValidator,InAppPyValidationErrorbundle_id='com.yourcompany.yourapp'auto_retry_wrong_env_request=False# if True, automatically query sandbox endpoint if# validation fails on production endpointvalidator=AppStoreValidator(bundle_id,auto_retry_wrong_env_request=auto_retry_wrong_env_request)try:exclude_old_transactions=False# if True, include only the latest renewal transactionvalidation_result=validator.validate('receipt','optional-shared-secret',exclude_old_transactions=exclude_old_transactions)exceptInAppPyValidationErrorasex:# handle validation errorresponse_from_apple=ex.raw_response# contains actual response from AppStore service.pass

8. App Store Response (validation_result / raw_response) example

{"latest_receipt":"MIIbngYJKoZIhvcNAQcCoIIbj...","status":0,"receipt": {"download_id":0,"receipt_creation_date_ms":"1486371475000","application_version":"2","app_item_id":0,"receipt_creation_date":"2017-02-06 08:57:55 Etc/GMT","original_purchase_date":"2013-08-01 07:00:00 Etc/GMT","request_date_pst":"2017-02-06 04:41:09 America/Los_Angeles","original_application_version":"1.0","original_purchase_date_pst":"2013-08-01 00:00:00 America/Los_Angeles","request_date_ms":"1486384869996","bundle_id":"com.yourcompany.yourapp","request_date":"2017-02-06 12:41:09 Etc/GMT","original_purchase_date_ms":"1375340400000","in_app": [{"purchase_date_ms":"1486371474000","web_order_line_item_id":"1000000034281189","original_purchase_date_ms":"1486371475000","original_purchase_date":"2017-02-06 08:57:55 Etc/GMT","expires_date_pst":"2017-02-06 01:00:54 America/Los_Angeles","original_purchase_date_pst":"2017-02-06 00:57:55 America/Los_Angeles","purchase_date_pst":"2017-02-06 00:57:54 America/Los_Angeles","expires_date_ms":"1486371654000","expires_date":"2017-02-06 09:00:54 Etc/GMT","original_transaction_id":"1000000271014363","purchase_date":"2017-02-06 08:57:54 Etc/GMT","quantity":"1","is_trial_period":"false","product_id":"com.yourcompany.yourapp","transaction_id":"1000000271014363"        }],"version_external_identifier":0,"receipt_creation_date_pst":"2017-02-06 00:57:55 America/Los_Angeles","adam_id":0,"receipt_type":"ProductionSandbox"    },"latest_receipt_info": [{"purchase_date_ms":"1486371474000","web_order_line_item_id":"1000000034281189","original_purchase_date_ms":"1486371475000","original_purchase_date":"2017-02-06 08:57:55 Etc/GMT","expires_date_pst":"2017-02-06 01:00:54 America/Los_Angeles","original_purchase_date_pst":"2017-02-06 00:57:55 America/Los_Angeles","purchase_date_pst":"2017-02-06 00:57:54 America/Los_Angeles","expires_date_ms":"1486371654000","expires_date":"2017-02-06 09:00:54 Etc/GMT","original_transaction_id":"1000000271014363","purchase_date":"2017-02-06 08:57:54 Etc/GMT","quantity":"1","is_trial_period":"true","product_id":"com.yourcompany.yourapp","transaction_id":"1000000271014363"        }, {"purchase_date_ms":"1486371719000","web_order_line_item_id":"1000000034281190","original_purchase_date_ms":"1486371720000","original_purchase_date":"2017-02-06 09:02:00 Etc/GMT","expires_date_pst":"2017-02-06 01:06:59 America/Los_Angeles","original_purchase_date_pst":"2017-02-06 01:02:00 America/Los_Angeles","purchase_date_pst":"2017-02-06 01:01:59 America/Los_Angeles","expires_date_ms":"1486372019000","expires_date":"2017-02-06 09:06:59 Etc/GMT","original_transaction_id":"1000000271014363","purchase_date":"2017-02-06 09:01:59 Etc/GMT","quantity":"1","is_trial_period":"false","product_id":"com.yourcompany.yourapp","transaction_id":"1000000271016119"        }],"environment":"Sandbox"}

9. App Store, asyncio version (available in the inapppy.asyncio package)

frominapppyimportInAppPyValidationErrorfrominapppy.asyncioimportAppStoreValidatorbundle_id='com.yourcompany.yourapp'auto_retry_wrong_env_request=False# if True, automatically query sandbox endpoint if# validation fails on production endpointvalidator=AppStoreValidator(bundle_id,auto_retry_wrong_env_request=auto_retry_wrong_env_request)try:exclude_old_transactions=False# if True, include only the latest renewal transactionasyncwithvalidator:# Use async context manager to ensure proper session managementvalidation_result=awaitvalidator.validate('receipt','optional-shared-secret',exclude_old_transactions=exclude_old_transactions)exceptInAppPyValidationErrorasex:# handle validation errorresponse_from_apple=ex.raw_response# contains actual response from AppStore service.pass

10. Development

Prerequisites

# macOS/Linuxcurl -LsSf https://astral.sh/uv/install.sh| sh# Windowspowershell -c"irm https://astral.sh/uv/install.ps1 | iex"

Setup and Testing

# Install development dependenciesmake dev# Run linting checksmake lint# Format code with ruffmake format# Run both lint and format checksmake check# Run testsmaketest# Run tests with pytest directlyuv run pytest -v

Available Make Commands

make setup# Install dependencies with uvmake dev# Install development dependencies with uvmake clean# Remove build artifactsmake build# Build distribution packagesmake release# Upload to PyPImaketest# Run tests with pytestmake lint# Run ruff lintingmake format# Format code with ruffmake check# Run lint and format checkmake install# Install package in editable mode

11. Donate