Sample Django App with PartnerJam integration

A demo app created using Django and ShopifyAPI v8.4+.

PartnerJam Integration

Link to the relevant parts of codebase demonstrating PartnerJam integration.

• Step 1 - Endpoint for storing the cookie
• Step 2 - Notifying PartnerJam about the installation
• Step 3 - Getting the discount from PartnerJam and creating charge
• PartnerJam client

Quick start

To run this app locally, you can clone the repository and do the following.

1. Create a .env file to specify this app's API key and API secret key app credentials that can be found in the Shopify Partners dashboard. PartnerJam related variables can be found in PartnerJam Dashboard.

SHOPIFY_API_KEY=<The API key app credential specified in the Shopify Partners dashboard>
SHOPIFY_API_SECRET=<The API secret key app credential specified in the Shopify Partners dashboard>
APP_URL=<The public app URL specified in the Shopify Partners dashboard>
SCOPES=<Scopes needed for the app>

SHOPIFY_APP_STORE_URL=<URL of your listing in Shopify app store, eg. https://apps.shopify.com/myapp>
PARTNERJAM_SECRET=<You can find this in PartnerJam dashboard>

Note: It's recommended to follow along the tutorial Build a Shopify App with Node and React to understand how to retrieve the API key and API secret key app credentials.

2. Run the following to install the required dependencies:

$ pip install -r requirements.txt

3. Change directories to the main sample_django_app app and run all pending migrations:

$ cd sample_django_app
$ python manage.py migrate

4. Ensure ngrok is running on port 8000:

$ ngrok http 8000

5. In a new terminal, run the server:

$ python manage.py runserver

6. Create an APP_URL environment variable based on the URL ngrok gives you. This is used in the CSRF_TRUSTED_ORIGINS and ALLOWED_HOSTS section of settings.py. Do not include a schema (http:// or https://) in this variable.

export APP_URL=<ngrok-url.ngrok.io>

7. From the Partner dashboard, update the "App URL" and "Allowed redirection URL(s)" to include the callback URL:

<https://ngrok-url.ngrok.io>/auth/shopify/callback

8. In your browser, open the https ngrok url to install and open this app on a shop. Requests to authenticated resources like the products view in the api app should now be secured with an Authorization: Bearer <session token> header.