Integrate with Adobe Commerce (Magento)

ℹ️

Integrate with Adobe Commerce (Magento) is in beta

Currently, the impact.com plugin integration supports version 2.4.3, 2.4.4, 2.4.5, 2.4.6, & 2.4.7 of Adobe Commerce. The plugin is not compatible with multi-store instances. The code for the plugin only works with the default store.

impact.com supports a plug-in integration with Adobe Commerce (Magento) e-commerce stores, enabling you to track and send conversions directly to impact.com via our API. Once integrated, you can begin discovering and recruiting partners to drive traffic to your store, create contracts that establish payouts for conversions, access reporting data, and more.

🚧

Supported configurations

This integration does not support multi-store/scope configurations. It will only connect with your default store.

Check before integrating

impact.com will complete several integration steps on your behalf. Check with your implementation engineer to ensure that the following configuration steps have been completed: Event Type, Gateway Tracking, General Tracking.

Install impact.com to Adobe Commerce via Composer

This guide follows the General CLI installation process offered by Adobe Commerce — refer to their documentation for additional information about installing extensions via a CLI.

☑️

Install impact.com

impact.com recommends installing the Partnership Cloud extension via Composer — it’s easier to install, update, and maintain your installation versus a manual installation.

  1. Using a terminal emulator, navigate to your root Adobe Commerce project directory and update your composer.json file with the following command:

     $ composer require impact_tech/module-magento-integration
    
  2. Enter your authentication keys — your public key is your username; your private key is your password.

  3. Wait for Composer to finish downloading and installing the impact.com Partnership Cloud.

    Updating dependencies (including require-dev)
    Package operations: 1 install, 0 updates, 0 removals
       - Installing impact_tech/module-magento-integration (X.Y.Z): Downloading (100%)
    Writing lock file
    Generating autoload files
    
  4. Verify that the impact.com Partnership Cloud has been installed properly with the following command:

     $ bin/magento module:status Impact_Integration
    

    By default, the impact.com Partnership Cloud should be installed and disabled.

  5. To enable the impact.com Partnership Cloud, use the following command to enable and clear any Adobe Commerce-generated static view files:

    $ bin/magento module:enable Impact_Integration --clear-static-content
    

    You should see the following output:

    The following modules have been enabled:
    - Impact_Integration
    To make sure that the enabled modules are properly registered, run 'setup:upgrade'.
    Cache cleared successfully.
    Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.
    Generated static view files cleared successfully.
    
  6. Register the impact.com Partnership Cloud with the following command:

     $ bin/magento setup:upgrade
    
  7. Recompile your Adobe Commerce project using the following command:

    $ bin/magento setup:di:compile
    
  8. If you’re running Adobe Commerce in Production mode, deploy the module’s static files with the following command:

     $ bin/magento setup:static-content:deploy
    
  9. Verify that Impact Partnership Cloud is enabled with the following command:

     $ bin/magento module:status Impact_Integration
    

    This command should return Module is enabled.

  10. Finally, flush and clean the cache with the following commands:

    $ bin/magento cache:flush
    $ bin/magento cache:clean
    

Activate & Configure impact.com

The following instruction set shows how to enable the integration using the Adobe Commerce Admin Dashboard.

☑️

Activate impact.com

  1. In the left navigation bar of the Adobe Commerce Admin Dashboard, select Settings → Integrations.

  2. On the Integrations screen, find the ImpactIntegration line item and select Activate.

    Confirm that impact.com can access the necessary files of your store by selecting Allow, then confirm that the integration reads Active under the Status column.

  3. In the left navigation bar of the Adobe Commerce Admin Dashboard, select Stores → Configuration.

  4. Select Impact Settings from the Impact section of the Configurations screen.

  5. Navigate to the bottom of the landing page to Already have an impact.com account? and select Set up your integration.

  6. Select Existing Customer and fill in all fields with your impact.com account information.

    Account DataDescription
    Impact Account SID*Navigate to
    → Settings → API
    to find your Account SID. Copy the full case-sensitive value.
    Auth Token*Navigate to
    → Settings → API
    to find your Auth Token. Copy the full case-sensitive value.
    Program ID*Enter your Program ID value (a.k.a Campaign ID value). To find this value, select your brand name in the top left corner of Impact. Your Program ID is shown in gray type under your Program name in the Program column.
    Event Type ID*Navigate to
    → Settings → Event Types
    . Your Event Type ID is the number in parenthesis next to the name of the event type — enter this value.
    Universal Tracking Tag (UTT)*Navigate to
    → Settings → General
    . Paste your entire unique UTT code into this field.
  7. In the top right corner of the screen, select Save Config.

End-to-End Testing

Once the impact.com app is fully installed to your Adobe Commerce store, you can begin end-to-end testing to ensure everything is working properly. Learn how to proceed with End-to-End Testing.