Download the PHP package clarity-tech/laravel-shopify without Composer

Laravel Shopify

Laravel Shopify is a simple package which helps to build robust integration into Shopify.

Installation

Add package to composer.json

composer require clarity-tech/laravel-shopify

Laravel 5.5+

Package auto discovery will take care of setting up the alias and facade for you

Laravel 5.4 <

Add the service provider to config/app.php in the providers array.

Setup alias for the Facade

Set shopify app authentication

Update config/app.php with below code and in routes add auth:shopify as middleware

Set credendials

in your .env file set these values from your app \ SHOPIFY_APIKEY=your-api-key \ SHOPIFY_SECRET=your-secret-key \ SHOPIFY_VERSION=admin-api-version \ only if app is private \ API_PASSWORD=private-app-password

Optional Configuration (publishing)

Laravel Shopify requires api key configuration. You will need to publish configs assets

php artisan vendor:publish --tag=shopify-config

This will create a shopify.php file in the config directory. You will need to set your API_KEY and SECRET

Usage

Frontend

Get the shopify session token using shopify fronend sdk & add Shopify-Token header in every request or send the inital url params appended by shopify

Backend

To install/integrate a shop you will need to initiate an oauth authentication with the shopify API and this require three components.

They are:

1. Shop URL (eg. example.myshopify.com)
2. Scope (eg. write_products, read_orders, etc)
3. Redirect URL (eg. http://mydomain.com/authorize)

This process will enable us to obtain the shops access token

Let's retrieve access token

To make the code less verbose we have added a app uninstalled job which can be subscribed via the app uninstalled webhook from shopify that can be configured automatically from your shop

After installation dispatch this job

which will subscribe to the app/uninstalled webhook under /webhooks/shopify/uninstalled route and will

To verify request(hmac)

To verify webhook(hmac)

To access Admin API use

To access API resource use

Let use our access token to get products from shopify.

NB: You can use this to access any resource on shopify (be it Product, Shop, Order, etc)

To pass query params

Controller Example

If you prefer to use dependency injection over facades like me, then you can inject the Class:

Miscellaneous

To get Response headers

To get specific header

Check if header exist

To get response status code or status message

Optional features

We also have a middleware for verifying the webhooks you can directly use it in your webhooks by the name verify.webhook

We have also added a automatic app uninstalled job dispatch when app is uninstalled by subscribing to the webhook topic app/uninstalled. To configure this you need to implement the interface Shopify/Contracts/ShopifyShop in your shop model and then

To customize the AppUninstalled Job Publish it by php artisan vendor:publish --tag=shopify-jobs

You might not need this We also dispatch events for webhooks if it is not for uninstalled topic for the same webhook ClarityTech\Shopify\Events\ShopifyWebhookRecieved