pcg92/in-app-purchase

©Nobuyori Takahashi < voltrue2@yahoo.com >

A node.js module for in-app purchase (in-app billing) and subscription for Apple, Google Play, Amazon Store, Roku, and Windows.

It supports Unity receipt also: Unity Documentation

NOTE Unity receipt supports the following: Apple, Google Play, and Amazon.

Required node.js version

0.12.0 >=

Online Demo and Documention

Online Demo

How to install

npm install in-app-purchase

How to use

The module supports both Promise and callbacks.

var iap = require('in-app-purchase');
iap.config({
	
	/* Configurations for Amazon Store */
	amazonAPIVersion: 2, // tells the module to use API version 2
	secret: 'abcdefghijklmnoporstuvwxyz', // this comes from Amazon
	// amazonValidationHost: http://localhost:8080/RVSSandbox, // Local sandbox URL for testing amazon sandbox receipts.
	
	/* Configurations for Apple */
	applePassword: 'abcdefg...', // this comes from iTunes Connect (You need this to valiate subscriptions)	
	
	/* Configurations for Google Play */
	googlePublicKeyPath: 'path/to/public/key/directory/' // this is the path to the directory containing iap-sanbox/iap-live files
	googleAccToken: 'abcdef...', // optional, for Google Play subscriptions
	googleRefToken: 'dddd...', // optional, for Google Play subscritions
	googleClientID: 'aaaa', // optional, for Google Play subscriptions
	googleClientSecret: 'bbbb', // optional, for Google Play subscriptions

	/* Configurations for Roku */
	rokuApiKey: 'aaaa...', // this comes from Roku Developer Dashboard
	
	/* Configurations all platforms */
	test: true, // For Apple and Googl Play to force Sandbox validation only
	verbose: true // Output debug logs to stdout stream 
});
iap.setup()
  .then(() => {
    // iap.validate(...) automatically detects what type of receipt you are trying to validate
    iap.validate(receipt).then(onSuccess).catch(onError);
  })
  .catch((error) => {
    // error...
  });

function onSuccess(validatedData) {
	// validatedData: the actual content of the validated receipt
	// validatedData also contains the original receipt
    var options = {
		ignoreCanceled: true, // Apple ONLY (for now...): purchaseData will NOT contain cancceled items
		ignoreExpired: true // purchaseData will NOT contain exipired subscription items
	};
	var purchaseData = iap.getPurchaseData(validatedData, options);
}

function onError(error) {
	// failed to validate the receipt...
}

Receipt data format

Apple

An Apple's receipt is a base64 encoded string.

Google Play

A Google Play's receipt consists of two components.

Signed Data: A JSON data of what the end user purchased.
Signature: A base64 encoded string.

The module requires the above two compoents to be as a JSON object or a string.

{
    "data": {Signed Data JSON},
    "signature": "Base 64 encoded signature string"
}

Amazon

An Amazon's receipt contains the following:

User ID: A string of Amazon Store user ID.
Receipt ID: A string of Amazon receipt.

The module requires the above two components to be as a JSON object or a string

{
    "userId": "User ID",
    "receiptId": "Receipt ID"
}

Roku

A Roku's receipt is a transaction ID string.

Windows

A Windows' receipt is an XML string.

Validate Receipts From Multiple Applications

You may feed different Google public key or Apple password etc to validate receipts of different applications with the same code:

Windows is NOT Supported

Google Public Key

iap.config(configObject);
iap.setup()
  .then(() => {
    iap.validateOnce(receipt, pubKeyString).then(onSuccess).catch(onError);
  })
  .catch((error) => {
    // error...
  });

Google Subscription

iap.config(configObject);
iap.setup()
  .then(() => {
    var credentials = {
      clientId: 'xxxx',
      clientSecret: 'yyyy',
      refreshToken: 'zzzz'
    };
    iap.validateOnce(receipt, credentials).then(onSuccess).catch(onError);
  })

Apple Subscription

iap.config(configObject);
iap.setup()
  .then(() => {
    iap.validateOnce(receipt, appleSecretString).then(onSuccess).catch(onError);
  })
  .catch((error) => {
    // error...
  });

Amazon

iap.config(configObject);
iap.setup()
  .then(() => {
    iap.validateOnce(receipt, amazonSecretString).then(onSuccess).catch(onError);
  })
  .catch((error) => {
    // error...
  });

Roku

iap.config(configObject);
iap.setup()
  .then(() => {
    iap.validateOnce(receipt, rokuApiKeyString).then(onSuccess).catch(onError);
  })
  .catch((error) => {
    // error...
  });

Helper Methods

[object] getPurchaseData([object] response, [object] options)

Returns an object to be used by isExpired and isCanceled.

[bool] options.ignoreCanceled

If true, the returned purchaseData excludes canceled item(s).

[bool] options.ignoreExpired

If true, the returned purchaseData excludes expired item(s).

[bool] isValidated([object] response)

Returns a boolean true if the given response of a receipt validation is a valid.

iap.validate(receipt)
    .then((response) => {
        if (iap.isValidated(response)) {
            // valid receipt
        }
    })
    .catch((error) => {
        // error...
    });

[bool] isCanceled([object] purchaseData)

Returns a boolean true if a canceled receipt is validated.

iap.validate(receipt)
    .then((response) => {
        var purchaseData = iap.getPurchaseData(response);
        if (iap.isCanceled(purchaseData)) {
            // receipt has been canceled
        }
    })
    .catch((error) => {
        // error...
    });

[bool] isExpired(object] purchaseData)

Returns a boolean true if a canceled receipt is validated.

NOTE This is subscription only.

iap.validate(receipt)
    .then((response) => {
        var purchaseData = iap.getPurchaseData(response);
        if (iap.isExpired(purchaseData)) {
            // receipt has been expired
        }
    })
    .catch((error) => {
        // error...
    });

[void] setAmazonValidationHost([string] host)

Allows you to set custom validation host name for tests.

[void] resetAmazonValidationHost()

Resets to Amazon's validation host name.

Google Play Public Key With An Environment Variable

You may not want to keep the public key files on your server(s).

The module also supports environment variables for this.

Instead of using googlePublicKeyPath: 'path/to...' in your configurations, you the following:

export=GOOGLE_IAB_PUBLICKEY_LIVE=PublicKeyHerePlz
export=GOOGLE_IAB_PUBLICKEY_SANDBOX=PublicKeyHerePlz

Google In-app-Billing Set Up

To set up your server-side Android in-app-billing correctly, you must provide the public key string as a file from your Developer Console account.

Reference: Implementing In-app Billing

Once you copy the public key string from the Developer Console account for your application, you simply need to copy and paste it to a file and name it iap-live as shown in the example above.

NOTE: The public key string you copy from the Developer Console account is actually a base64 string. You do NOT have to convert this to anything yourself. The module converts it to the public key automatically for you.

Google Play Store API

To check expiration date or auto renewal status of an Android subscription, you should first setup the access to the Google Play Store API. You should follow these steps:

Part 1 - Get ClientID and ClientSecret

Go to https://play.google.com/apps/publish/
Click on Settings
Click on API Access
There should be a linked project already, if not, create one. If you have it, click it.

You should now be at: https://console.developers.google.com/apis/library?project=xxxx

Under Mobile API's, make sure "Google Play Developer API is enabled".
Go back, on the left click on Credentials
Click Create Credentials button
Choose OAuth Client ID
Choose Web Application

Give it a name, skip the Authorized JS origins
Aadd this to Authorized Redirect URIs: https://developers.google.com/oauthplayground
Hit Save and copy the clientID and clientSecret somewhere safe.

Part 2 - Get Access and Refresh Tokens

Go to: https://developers.google.com/oauthplayground
On the right, hit the gear/settings.
Check the box: Use your own OAuth credentials
- Enter in clientID and clientSecret
- Close
On the left, find "Google Play Developer API v2"

Select "https://www.googleapis.com/auth/androidpublisher"

Hit Authorize Api's button
Save Authorization Code

This is your: googleAccToken

Hit Exchange Authorization code for token
Grab: Refresh Token

This is your: googleRefToken

Now you are able to query for Android subscription status!

Amazon App Store Reference

https://developer.amazon.com/docs/in-app-purchasing/iap-rvs-for-android-apps.html

Windows Signed XML

in-app-purchase module supports the following algorithms:

Canonicalization and Transformation Algorithms

Exclusive Canonicalization http://www.w3.org/2001/10/xml-exc-c14n#
Exclusive Canonicalization with comments http://www.w3.org/2001/10/xml-exc-c14n#WithComments
Enveloped Signature transform http://www.w3.org/2000/09/xmldsig#enveloped-signature

Hashing Algorithms

SHA1 digests http://www.w3.org/2000/09/xmldsig#sha1
SHA256 digests http://www.w3.org/2001/04/xmlenc#sha256
SHA512 digests http://www.w3.org/2001/04/xmlenc#sha512

HTTP Request Configurations

The module supports the same configurations as [npm request module] (https://www.npmjs.com/package/request#requestoptions-callback)

pcg92 / in-app-purchase

Required node.js version

Online Demo and Documention

How to install

How to use

Receipt data format

Apple

Google Play

Amazon

Roku

Windows

Validate Receipts From Multiple Applications

Windows is NOT Supported

Google Public Key

Google Subscription

Apple Subscription

Amazon

Roku

Helper Methods

[object] getPurchaseData([object] response, [object] options)

[bool] options.ignoreCanceled

[bool] options.ignoreExpired

[bool] isValidated([object] response)

[bool] isCanceled([object] purchaseData)

[bool] isExpired(object] purchaseData)

[void] setAmazonValidationHost([string] host)

[void] resetAmazonValidationHost()

Google Play Public Key With An Environment Variable

Google In-app-Billing Set Up

Google Play Store API

Part 1 - Get ClientID and ClientSecret

Part 2 - Get Access and Refresh Tokens

Amazon App Store Reference

Windows Signed XML

Canonicalization and Transformation Algorithms

Hashing Algorithms

HTTP Request Configurations

About

Languages