rawaby88/shopify-oauth-laravel

A simple package to make Shopify App Oauth easy.

0.2 2024-05-10 10:47 UTC

Requires

• php: ^8.1
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• orchestra/testbench: ^8.22
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3

MIT

• Joy Mendonca

• laravel
• Joy Mendonca
• shopify-oauth-laravel

README

This package provides a convenient way to integrate Shopify OAuth authentication into your Laravel application. It simplifies the process of setting up OAuth with Shopify, allowing you to focus on building your application's features rather than dealing with the intricacies of authentication.

Installation

You can install this package via Composer. Run the following command in your terminal:

composer require joymendonca/shopify-oauth-laravel

Configuration

After installing the package, you'll need to publish and run the migrations with:

php artisan vendor:publish --tag="shopify-oauth-laravel-migrations"
php artisan migrate

You can also publish the config file using:

php artisan vendor:publish --tag="shopify-oauth-laravel-config"

You will now need to setup the environment variables in your .env file:

APP_URL="https://your-website.com"                    #The base url for your website
SHOPIFY_CLIENT_ID="your-shopify-client-id"            #Shopify App Client ID
SHOPIFY_CLIENT_SECRET="your-shopify-client-secret"    #Shopify App Client Secret
SHOPIFY_SCOPES="read_products,write_products"         #Shopify App Scopes Needed
SHOPIFY_APP_HOME_URL='/'                              #URL you want the user to get redirected to when the launch the app

You can register the routes using the code below in web.php:

use joymendonca\ShopifyOauthLaravel\ShopifyOAuthLaravelRoutes;

ShopifyOAuthLaravelRoutes::register();

Make sure the app install url registered in your shopify app is "https://your-website.com/shopify-app-auth/install" and the redirect url is "https://your-website.com/shopify-app-auth/load"

Usage

Once the package is installed and configured, you can start using Shopify OAuth in your Laravel application.

You can get the access token and store url of the logged in as below:

use joymendonca\ShopifyOauthLaravel\Facades\ShopifyOauthLaravel;

$access_token = ShopifyOauthLaravel::getStoreAccessToken();
$store_url = ShopifyOauthLaravel::getStoreUrl();