Skip to content
English
Need more help? Submit a request Customer portal
Go to app.sprii.io
  • There are no suggestions because the search field is empty.

Set up the Magento 2 integration

Install the Sprii extension with your Magento vendor, then connect your store.

The integration brings Magento products into Sprii campaigns and sends shoppers to Magento checkout. Products used in active campaigns refresh about every five minutes. Completed-order status can appear in Sprii; manage the order in Magento.

Before you start

Your Magento vendor must install the extension through your normal deployment process. The current elisa/product_api package, version 2.6.2, requires PHP 7.1 or later and below 8.4. Have your vendor check all its published Magento component requirements against your store before deployment. ELISA is Sprii's former name.

You also need a Magento administrator who can create an API integration, your storefront URL and the REST domain or store code confirmed by your vendor.

Open the integration in Sprii

  1. Go to Page settings Page settings in Sprii > E-commerce integration E-commerce integration in Sprii. Find Magento 2 and click Configure.

    Magento 2 Configure card
  2. Click Activate webshop Activate webshop button. This opens the editable settings; the store is not connected yet. Keep this form open while you obtain the Magento credentials.

Install the extension and create Magento credentials

  1. Ask your Magento vendor to install or update the extension and finish the required deployment steps. The package command is:

    composer require elisa/product_api

    Composer command for the Magento extension
  2. In Magento, go to System > Extensions > Integrations and add a new integration. Enter a clear Name, the contact Email and your administrator password when prompted.
  3. Open API and choose Custom for Resource Access. Select Elisa API - Products, including Get products by timestamp, Custom cart create and Get orders by timestamp. Include Refresh events if you use the Onsite events widget. These are the Sprii extension's permissions.
  4. Click Save, then Activate beside the new integration. Click Allow to display its tokens.
  5. Copy Consumer Key, Consumer Secret, Access Token and Access Token Secret to a secure location, then click Done. Use these four values in the Sprii form below.

Enter the connection details in Sprii

Return to the Magento 2 form you opened in Sprii. Fill in:

  • Site URL: your Magento storefront address.

    Magento 2 Site URL field
  • REST Domain or Store Code: the value supplied by your Magento vendor.

    REST Domain or Store Code field
  • Consumer Key: the matching token from Magento.

    Consumer Key field
  • Consumer Secret: the matching token from Magento.

    Consumer Secret field
  • Access Token: the matching token from Magento.

    Access Token field
  • Access Token Secret: the matching token from Magento.

    Access Token Secret field

Leave Use Bearer Authentication Unchecked Sprii checkbox unchecked for this four-token connection. Read and accept the integration terms, then click Save Save button

Resolve any error shown in the form. A successful connection confirms that Sprii can read the extension version and fetch product data. It does not verify checkout or payment. The connection belongs to this Sprii Page and supplies its campaigns; existing active campaigns still use the five-minute product refresh cycle.

Limitations

Important: A zero or free price in Sprii can become the Magento store price at checkout. Check the checkout price before your first live show.

  • Starting Magento checkout from Sprii clears the shopper's current Magento cart and rebuilds it with the Live Shopping products.
  • An inactive Magento product can make checkout fail. Bundle products are not supported for import or checkout.
  • Check payment, cancellation, refund and fulfillment in Magento before acting on an order shown in Sprii.
  • Only products used in active campaigns follow the five-minute refresh cycle.


Need help? Contact Sprii Support