Easiest way to integrate is to install Firework Magento Extension. This way you can automatically sync products, add widgets into your templates or pages.

Detailed guide for installation can be found here.

Extension Installation guide

Step 1: First download the Firework Extension for Magento 2

Navigate to the Magento Marketplace (My Profile - Access Keys) Paste the access keys in your auth.json file inside magento project.

Use the "composer require firework/firework" command to add the extension to your project.

Please run the following commands to install code base and database schemas.

 php bin/magento setup:di:compile
 php bin/magento setup:upgrade
 php bin/magento setup:static-content:deploy -f
 php bin/magento indexer:reindex
 php bin/magento cache:clean
 php bin/magento cache:flush 

Once you’ve executed all the commands you can exit the command line interface and open your Administrator console for Magento 2. Navigate to the Store, and then its Configuration. If there is a new tab in the menu with the Firework Logo, it means you’ve installed the Firework extension correctly, and it’s ready to use.

NOTE: Do not modify the Endpoint URL in Webhook Configuration, it will be prefilled and modifying it will break the integration.

If the above steps seem confusing or daunting to you, feel free to reach out to your Firework Account Manager. They are more than willing to assist you in this configuration.

NOTE: To implement all changes on the magento storefront, the store admin needs to flush the cache each time settings and configurations are done.

Step 2: Configure the Firework Extension

Once the Firework Extension is installed, we need to ensure it is configured correctly to integrate with your stores. These steps need to be performed by a Magento store administrator.

Navigate to System and then to Integrations, and select Add New Integration. Fill out the general information on the Integration and Save your changes.

Select API from the left-hand navigation menu and allow access to the below features:

  • Cart

  • Catalog

  • Customers

  • Marketing

  • My Account

Step 3: Add Widgets

Navigate to the page upon which you want to display a Firework widget. Go to the page editor, and select Insert Widget, and then select Firework Videos as your Widget Type.

From the Widget Options you can select the layout you wish to add to the page, and use the dropdown menus to select the appropriate Channel and Playlist.

Step 4: Import Products

Once you connect to the Firework Dashboard you will be directed to your store. The Products tab will include any imported products already. But the Import Products tab will list all the products that you have in your magento store.

You can click the Import button on the right to add the product from your Magento Store to your Firework Store. This will enable you to apply this product on product cards on your Firework Videos and Livestreams.

If products are already imported you will see Sync button to update the products data in your firework account

Step 5: Enable Purchase Tracking

Please Navigate to the Store -> Settings -> Configuration -> Firework -> Purchase Tracking -> Enable

Step 6: Activate Cart Integration

Select a video in your library, and use the options menu … to select Edit.

In the video options use the Video Overlays button to add a Product Card to the video.

Use the dropdown menu to select the store that you have integrated to your Magento Store.

Then select the product you want to overlay atop the video you are editing and click Add.

Once your video is edited to include the product you can return to the page on which you embedded your Firework widget.

If you select your video you will see the Product Card on the playing video.

Selecting the product and Shop Now will put the product in the shopping cart for this session on your site.

Last updated