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 1.9 integration

Use the supported Magento plugin and a dedicated SOAP user to enter the Sprii connection details.

This guide connects an existing Magento 1.9 store using Sprii’s magento1-1.2.2.zip package, Elisa_ProductApi 1.2.2, and a dedicated Magento SOAP/XML-RPC user. Have your Magento administrator handle the installation. Magento 2 uses a separate integration.

Before you start

You need access to the intended Sprii Page, your Magento store address, and a Magento administrator who can install the package and create a dedicated integration user. Before installing Elisa_ProductApi 1.2.2, have the administrator assess its requirement for Resource Access: All, which gives the dedicated user access to every Magento SOAP API resource. If this access is unacceptable, do not install or connect with this package. For a multi-store setup, note that this integration uses the default store view of the default website; it does not let you select a different store view.

Open the integration in Sprii

  1. Select the intended Page. Open Page settings Page settings in Sprii > E-commerce integration E-commerce integration in Sprii. Find Magento 1.9 and click Configure.

    Magento 1.9 Configure card
  2. If the integration is inactive, click Activate webshop Activate webshop button. This does not install the Magento plugin or verify a connection.

Install the plugin in Magento

  1. In the Sprii settings, click Download plugin Download plugin button. Give magento1-1.2.2.zip to your Magento administrator.
  2. Have the administrator back up the store files and database before deployment, including any existing module data. Important: The supplied installation script drops and recreates its two cart-reference tables when it runs. Existing data in those tables must be backed up before the module is installed.
  3. If the store uses Magento compilation, have the administrator disable it before deploying the files. Extract the ZIP and open its outer magento1-1.2.2 folder. Merge app/code/local/Elisa/ProductApi and app/etc/modules/Elisa_ProductApi.xml into the matching paths under the Magento store root. Keep the store’s other app files intact. The package already declares the module enabled.
  4. Refresh Magento’s configuration cache through System > Cache Management, then reload Magento and resolve any module or setup errors. If compilation was enabled, have the administrator rebuild it after the module loads successfully. Complete this before creating the integration role and saving the Sprii connection.

Create a dedicated Magento user

Important: The unmodified Elisa_ProductApi 1.2.2 package requires Resource Access set to All for its dedicated SOAP user. This grants that user access to every Magento SOAP API resource, not just the products, carts and orders used by Sprii. Have your Magento administrator assess this access before connecting. If it is unacceptable, do not connect with this package.

This requirement is specific to this package. Selecting only its ProductApi permissions does not work because the package checks an API permission that its role tree does not declare.

  1. In Magento, open System > Web Services > SOAP/XML-RPC - Roles > Add New Role. Give the role a unique name identifying it as the Sprii role.
  2. Open Role Resources, set Resource Access to All, then click Save Role. Reserve this role for the dedicated Sprii user.
  3. Open System > Web Services > SOAP/XML-RPC - Users > Add New User. Complete the required account details with a unique User Name. Enter a long, random API Key used only for this connection, and enter the same value in API Key Confirmation. Current Admin Password, when required, confirms the administrator's action; it is not the API key for Sprii.
  4. Under User Role, select the dedicated Sprii role and click Save User. Use this account and key only for Sprii.

Save the connection in Sprii

After the supported plugin is installed and the dedicated user is saved, return to the open Magento 1.9 settings:

  1. Enter the Magento store address in Site Url.

    Site Url field, blank
  2. Enter that integration user's User Name in Soap Username.

    Soap Username field, blank
  3. Enter the same user's API Key in API Key. Keep the API key private; do not paste Current Admin Password here.

    API Key field, blank
  4. Leave Checkout Type set to Sprii Magento Checkout, the only option in the form. Select Add vat to webshop price (only if webshop has prices excl vat) Unchecked Sprii checkbox only if your webshop prices exclude VAT.

    Checkout Type set to Sprii Magento Checkout
  5. Click Save Save button. For an active integration, Sprii checks the SOAP connection by requesting product data. If you see Is the user and password correct?, check the Site Url, that the module is installed and enabled, the SOAP username and API key, and the dedicated role’s Resource Access setting. The same message can indicate a module or permission error, not just incorrect credentials. Check the products you intend to use in Sprii; saving alone does not prove that products imported or checkout works.

Limitations

Sprii Magento Checkout creates a cart through the module and sends the shopper to the Magento cart page. Sprii schedules product and order refreshes every five minutes; product refreshes cover SKUs used in active campaigns. This schedule is not a guaranteed update time. Sprii counts linked orders with Magento status Processing or Complete; verify payment in Magento before shipping. This procedure does not cover Magento 2 or OpenMage.


Need help? Contact Sprii Support