Download the PHP package zdk/applestore without Composer
On this page you can find all versions of the php package zdk/applestore. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zdk/applestore
More information about zdk/applestore
Files in zdk/applestore
Package applestore
Short Description Laravel receipt validator for Google Play
License MIT
Homepage https://github.com/imdhemy/laravel-in-app-purchases
Informations about the package applestore
Laravel In-App purchase
Google Play and App Store provide the In-App Purchase (IAP) services. IAP can be used to sell a variety of content, including subscriptions, new features, and services. The purchase event and the payment process occurs on and handled by the mobile application (iOS and Android), then your backend needs to be informed about this purchase event to deliver the purchased product or update the user's subscription state.
Laravel In-App purchase comes to help you to parse and validate the purchased products and handle the different states of a subscription, like New subscription , auto-renew, cancellation, expiration and etc.
Table of contents
- Installation
- Configuration
- i. Generic Configurations:
- i.1 Routing
- i.2 Event Listeners
- ii. Google Play Configurations:
- ii.1 Google Application Credentials
- ii.2 Google Play Package Name
- iii. App Store Configurations
- iii.1 App Store Sandbox
- iii.2 App Store Password
- Sell Products
- Google Products
- App Store Products
- Sell Subscriptions
- Google Play Subscriptions
- App Store Subscriptions
- Purchase Events
- Testing
Installation
Install the package via composer:
composer require imdhemy/laravel-purchases
Publish the config file:
php artisan vendor:publish --provider="Imdhemy\Purchases\PurchaseServiceProvider" --tag="config"
Configuration
The published config file config/purchase.php
looks like:
Each configuration option is illustrated in the configuration section.
i. Generic Configurations:
The generic configurations are not specific to a particular provider of the two supported providers (Google and Apple).
i.1 Routing
This package adds two POST
endpoints to receive the Real-Time Developer Notifications, and the The App Store Server Notifications.
Provider | URI | Name |
---|---|---|
Google Play | /purchases/subscriptions/google |
purchase.serverNotifications.google |
App Store | /purchases/subscriptions/apple |
purchase.serverNotifications.apple |
These routes can be configured through the routing
key in the config file. For example:
i.2 Event Listeners
Your application should handle the different states of a subscription life. Each state update triggers a specified event. You can create an event listener to update your backend on each case.
Add the created listener to the associated event key.
All events extend the \Imdhemy\Purchases\Events\PurchaseEvent
abstract class, which implements the \Imdhemy\Purchases\Contracts\PurchaseEventContract
interface. Check the Purchase Events section for more information.
ii. Google Play Configurations:
The following set of configurations are specific to google play:
ii.1 Google Application Credentials
Requests to the Google Play Developer API, requires authentication and scopes. To authenticate your machine create a service account, then upload the downloaded JSON file google-app-credentials.json
to your server, and finally add GOOGLE_APPLICATION_CREDENTIALS
key to your .env
file and set it to the path of JSON file.
- In the Cloud Console, go to the Create service account key page.
- From the Service account list, select New service account.
- In the Service account name field, enter a name.
- From the Role list, select Project > Owner.
- Click Create. A JSON file that contains your key downloads to your computer.
- Upload the JSON file to your storage directory, or any other protected directory.
- Set the
.env
keyGOOGLE_APPLICATION_CREDENTIALS
to the JSON file path.
ii.2 Google Play Package Name
The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
iii. App Store Configurations
The following set of configurations are specific to the App Store.
iii.1 App Store Sandbox
The configuration key appstore_sandbox
is a boolean value that determines whether the requests sent to the App Store are in the sandbox or not.
iii.2 App Store Password
Request to the App Store requires the key appstore_password
to be set. Your app’s shared secret, which is a hexadecimal string.
Sell Products
Google Products
You can use the \Imdhemy\Purchases\Facades\Product
facade to acknowledge or to get the receipt data from Google Play as follows:
Each key has a getter method prefixed with get
, for example: getKind()
to get the kind
value.
For more information check:
App Store Products
You can use the \Imdhemy\Purchases\Facades\Product
to send a verifyReceipt request to the App Store. as follows:
As usual each key has a getter method.
For more information check:
Sell Subscriptions
Google Play Subscriptions
You can use the \Imdhemy\Purchases\Facades\Subscription
facade to acknowledge or to get the receipt data from Google Play as follows:
The SubscriptionPurchase
resource indicates the status of a user's inapp product purchase. This is its JSON Representation:
For more information check:
App Store Subscriptions
You can use the \Imdhemy\Purchases\Facades\Subscription
to send a verifyReceipt request to the App Store. as follows:
For more information check:
Purchase Events
As mentioned the configuration section, Your application should handle the different states of a subscription life. Each state update triggers a specified event. You can create an event listener to update your backend on each case.
All triggered events implement Imdhemy\Purchases\Contracts\PurchaseEventContract
interface, which allows you to get a standard representation of the received notification through the getServerNotification()
method.
The retrieved notification is of type \Imdhemy\Purchases\Contracts\ServerNotificationContract
which allows you to get a standard representation of the subscription using the getSubscription()
method.
The subscription object provides the following methods:
getExpiryTime()
returns aTime
object that tells the expiration time of the subscription.getItemId()
returns the purchased subscription id.getProvider()
returns the provider of this subscription, eithergoogle_play
orapp_store
.getUniqueIdentifier()
returns a unique identifier for this subscription.getProviderRepresentation()
returns eitherSubscriptionPurchase
orReceiptResponse
based on the provider.
Here is an example of an auto-renewed subscription:
Testing
TODO: add testing examples.
All versions of applestore with dependencies
ext-json Version *
imdhemy/appstore-iap Version ^0.3
imdhemy/google-play-billing Version ^0.3
nesbot/carbon Version ^2.41