Shopify Guide

Omneo for Shopify is a self-hosted plugin to integrate Omneo with Shopify. 

Features

  • Handle redemptions
  • Sync products to Omneo
  • Sync profiles to and from Omneo
  • Safely retrieve profile and location information

Prerequisites 

Before installing the plugin, you'll need to obtain the following connection details:

Omneo Credentials

  • Domain
    This takes the form of example.omneoapp.io and is where your Omneo installation lives. If you login to your dashboard at foo.dashboard.omneo.io, your Omneo domain is foo.omneoapp.io.

  • Token
    This is the secure token which identifies you to the API. It can be generated from the Omneo dashboard and is associated with your user account. It is advisable that you create a separate Omneo user specifically for your integration. You will need the following scopes.

    • create-profiles
    • update-profiles
    • read-profiles
    • create-products
    • read-products
    • create-webhooks
    • delete-webhooks
    • read-locations

  • Secret
    You can obtain this secret from within your Omneo dashboard. It is used to verify that it is indeed Omneo sending webhook requests.

Shopify Credentials

  • Shop
    You can obtain this from your Shopify URL. If your Shopify URL is kindflowers.myshopify.com then your Shop is kindflowers.
  • Key
    You can obtain this secret from within your Shopify dashboard.
  • Password
    You can obtain this secret from within your Shopify dashboard.
  • Secret
    You can obtain this secret from within your Shopify dashboard. It is used to verify that it is indeed Shopify sending webhook requests.

Installation

1. Install Dependencies

composer install

2. Configure Environment

If using Elastic Beanstalk or other hosting platform which supports environment variables, you should configure the following from within the configuration interface.

If your platform does not support environment variables, copy .env.example to .env and configure them there.

  • SHOPIFY_SHOP
  • SHOPIFY_KEY
  • SHOPIFY_PASSWORD
  • SHOPIFY_SECRET
  • OMNEO_DOMAIN
  • OMNEO_TOKEN
  • OMNEO_SECRET

3. Install

To finish the setup, simply run the installation command:

php artisan install

Behind the scenes this command will setup the required webhooks at Omneo and Shopify to facilitate the synchronisation of data.

If you only need to setup one side of the connection, you can use the following commands:

php artisan install:{omneo|shopify}

For access to source code contact your Omneo Implementation Partner

 

Related articles