Skip to main content

Adobe Commerce/Magento 2 Installation Instructions

Step-by-step setup for the Adobe Commerce/Magento 2 integration, from subscribing in the marketplace through authentication, operational configuration, and post-installation verification.

This article walks you through installing and configuring the Adobe Commerce/Magento 2 integration in iPaaS.com. It covers what to prepare in Magento 2 first, how to subscribe and enter your subscription settings, how to authenticate the connection, and how to confirm the integration is working. For a standalone reference to every credential and setting, see Connections and Settings.

Before You Begin

Before you install the subscription, prepare the following in your Adobe Commerce/Magento 2 store. You will enter these values in iPaaS.com during setup.

  • A Magento 2 Integration and access token (recommended). In the Magento Admin, go to System > Extensions > Integrations, add a new integration, and enter its name and details. On the API tab, set Resource Access to grant the integration the resources it needs (full access is recommended), then select Activate and Allow to generate the credentials. Magento displays a Consumer Key, Consumer Secret, Access Token, and Access Token Secret. The Access Token is the value you will enter in iPaaS.com. Magento's own guidance for creating an integration is published in the Adobe Commerce integrations documentation.

Adding a new integration in the Magento Admin

Activating the integration and selecting Allow to generate its credentials

- Admin credentials (alternative). If you connect with a username and password instead of an access token, have a Magento admin username and password available. Use this method only when an access token is not available, and only when two-factor authentication has been disabled for that admin account. - The store's base URL. The public URL of your Magento 2 store. iPaaS.com builds the API address from this value. - A reachable Magento 2 REST API. The store's REST API must be operational and reachable from iPaaS.com. You can confirm the API works as described in the Adobe Commerce web API documentation. - Multi-Source Inventory, if you hold stock in more than one location. The integration writes stock against Magento inventory sources, so Multi-Source Inventory must be installed and configured, and the sources you intend to use must exist in the Magento Admin under Multi Source Inventory before any inventory transfer runs. Source codes are case-sensitive and cannot be deleted once created, so confirm them before the first transfer. - A stock-reservation fix, if you enable Multi-Source Inventory. With MSI enabled, Magento's own stock reservation can under-report available quantities and block order fulfillment. Install an extension that disables stock reservation to resolve it — iPaaS.com publishes one on the Adobe Commerce Marketplace. Equivalent community extensions that disable stock reservation also work.

If you will drive real-time updates from Magento 2 into iPaaS.com, note that Magento 2 does not natively provide webhooks and requires a third-party Magento extension. Setting this up is covered separately in the Mageplaza Webhooks article.

Enabling access tokens as bearer tokens

In current versions of Adobe Commerce, a standalone integration access token is disabled by default for token-based authentication because a never-expiring token is a security risk. To use the recommended access-token method, allow access tokens to be used as bearer tokens in your store:

  1. In the Magento Admin, go to Stores > Configuration.

  2. Select Services, then OAuth.

  3. Under Consumer Settings, set Allow OAuth Access Tokens to be used as standalone Bearer tokens to Yes.

  4. Select Save Config to apply the change.

Magento Admin Stores Configuration, where the OAuth settings are found

The OAuth Consumer Settings panel, showing the option that allows access tokens to be used as standalone bearer tokens

Adobe's reference for token-based authentication is published in the Adobe Commerce authentication documentation. If you authenticate with a username and password instead of an access token, you do not need this setting.

Increasing the Web API input limit

Adobe Commerce caps the number of items a single API request may carry. A product with many attribute values — a garment with a long list of sizes and colours, for example — can exceed that cap, and the transfer for that product fails. Raise the limit before transferring a catalogue of any size:

  1. In the Magento Admin, go to Stores > Configuration.

  2. Select Services, then Magento Web API.

  3. Under Web API Input Limits, raise the input limit. A value of 9999 is enough for the product shapes this integration sends.

  4. Select Save Config to apply the change.

Adobe's reference for this cap is published in the Adobe Commerce API security documentation. If input limiting is disabled in your store, this step does not apply.

Installation Instructions for Integration Setup

  1. In iPaaS.com, go to Subscriptions Management > Subscriptions and select Search Certified Integration Marketplace and Subscribe.

  2. Select the Adobe Commerce/Magento 2 tile in the marketplace.

    Search Certified Integration Marketplace and Subscribe on the iPaaS.com Subscriptions page

    The Adobe Commerce/Magento 2 tile in the certified integration marketplace

    3. On the Subscription Detail page, select Subscribe. 4. Enter a name for the subscription and select a version. Use a name that is unique and meaningful within your company. - Format: [Product Name] - [Environment/Purpose] - Example: Adobe Commerce/Magento 2 - Production 5. Leave Create Default Mappings selected (recommended). This installs the integration's template mappings so you can start syncing without building each mapping by hand. Clear this checkbox only if you intend to create all mappings from scratch yourself. 6. Enter the API endpoint for your store in the Magento2 Api Url field. This is the public base URL of your Magento 2 store. - Test/Sandbox: the URL of your Magento 2 staging store, for example https://<your-magento-domain> - Production: the URL of your live Magento 2 store 7. Enter your authentication credentials as described in Authentication Configuration below. 8. Enter the behavior settings described in Operational Configuration and Additional Configuration Options below. 9. Set the throttle and concurrency values. These fields are pre-populated by the integration preset, so in most cases you can leave them as-is. If you tune them, use the following as a starting point:

Field

Recommended value

Description

API Throttle Limit

Initial setup 5; ongoing 500; high volume 500

The maximum number of calls the integration makes to Magento 2 within each throttle window.

API Throttle Seconds

60

The length, in seconds, of the throttle window the API Throttle Limit is measured against.

Concurrent Connections

0 (uses the platform default); a small value such as 2 can help if your store returns rate-limit errors

The number of simultaneous connections the integration is allowed to open.

Concurrent Batch Executions

5 (the integration uses 10 when left blank)

The number of batches the integration processes at the same time.

  1. Select Apply to save the settings.

The Subscription Settings page where the Magento 2 connection and behavior settings are entered

For a fuller explanation of how the throttle fields work, see Subscription Configuration – Edit. All of these settings are also documented in Connections and Settings.

Authentication Configuration

The integration supports three ways to authenticate to Magento 2. Choose the one that matches how your store issues credentials. The integration access token is the standard, recommended method.

Integration access token (standard)

  • Credential: Magento 2 Integration access token

  • Location in Magento: in System > Extensions > Integrations, open your integration and use the Access Token generated when you activated it.

  • iPaaS.com field: enter the access token in Magento2 Api Integration Key.

  • Description: iPaaS.com sends this token as a bearer token on every API request. This is the recommended method and the one used by most subscriptions.

OAuth 1.0a (secondary)

  • Credential: a consumer key, consumer secret, access token, and access token secret

  • Location in Magento: the same System > Extensions > Integrations screen displays all four values when you activate an integration.

  • Required: Conditional — used only when your connection is configured with a full set of OAuth 1.0a credentials instead of a single access token. Each request is signed with these credentials.

Username and password (secondary)

  • Credentials: your Magento admin username and password

  • Location in Magento: the credentials you use to sign in to the Magento Admin.

  • iPaaS.com fields: enter them in Magento2 Api Username and Magento2 Api Key.

  • Required: Conditional — used only when you connect with admin credentials instead of an access token.

Important Notes

  • For the access-token method to work, your Magento store must allow OAuth access tokens to be used as standalone bearer tokens. Enable this before connecting, as described in Enabling access tokens as bearer tokens above.

  • When you use the username-and-password method, iPaaS.com exchanges the credentials for a short-lived admin token. Magento issues this token with a default lifetime of about four hours, and iPaaS.com refreshes it automatically as needed. Use this method only as an alternative to an access token, and only when two-factor authentication has been disabled for the admin account.

Operational Configuration

These settings control how the integration batches and formats data. They are optional and, where the integration ships a preset, come pre-populated. They are documented in full in Connections and Settings.

  • Inventory Batch Max Size: Caps the number of inventory records the integration sends in a single inventory batch. Purpose: keeps large inventory syncs from overwhelming your store by limiting how many items are processed at once. Example: set to 5 to send inventory five records at a time. Leave blank to use the integration's default batching.

  • Concurrent Batch Executions: Sets how many batches the integration processes at the same time. Purpose: balances sync throughput against the load placed on your store. Example: set to 5 to run five batches at once; the integration uses 10 when the field is left blank.

  • Bypass Inventory Check On Tracking Upload: When set to true, the integration skips the inventory availability check when uploading shipment tracking. Purpose: lets you create shipments for items that do not track inventory without hitting insufficient-stock errors. Example: set to true to disable the stock check on tracking upload; defaults to false when left blank.

  • Auto-Ship Days: Sets a default number of days used when automatically shipping orders, where that behavior is configured. Purpose: provides a default shipping window so orders can auto-ship without a per-order value. Example: set to 3 to use a three-day default.

  • Pricing Tier Field Separator and Pricing Tier Record Delimiter — Define how tier-pricing data supplied as delimited text is split. The field separator divides the values within a single tier-pricing entry; the record delimiter separates one entry from the next. Purpose: lets the integration read tier prices from a single delimited field. Example: with a comma (,) field separator and a pipe (|) record delimiter, two comma-separated tier entries joined by a pipe are read as two separate tier prices. Both are pre-populated by the integration preset.

  • Shipment Items Field Separator and Shipment Items Record Delimiter — Define how shipment-item data supplied as delimited text is split. The field separator divides the values within a single shipment-item entry; the record delimiter separates one entry from the next. Purpose: lets the integration read a list of shipment items from a single delimited field. Example: with a comma (,) field separator, an entry of 12345,2 is read as order item 12345 with quantity 2; with a pipe (|) record delimiter, two such entries joined by a pipe are read as two shipment items. Both are pre-populated by the integration preset.

Additional Configuration Options

  • Magento Store: The Magento store scope the integration operates against. Default/Format: set this to all, which is the supported scope and the value tested with the template mappings.

  • Version: Records the Adobe Commerce/Magento 2 platform version your store runs. Default/Format: pre-populated by the integration preset and used for reference; the integration does not change its behavior based on this value.

Post-Installation Verification

After you apply the subscription settings, confirm the integration is connected and moving data.

  1. Connection check. When you save the subscription, iPaaS.com validates the connection by making a live read against your Magento 2 store. If the credentials are missing or invalid, the subscription reports a connection error — recheck the store URL and the access token (or admin credentials), confirm the bearer-token store setting is enabled, and save again.

  2. Data sync check. Run a Manual Sync for a record you can identify in Magento 2, then confirm the record transfers as expected. If a sync does not complete, review the details on the Dashboard under Integration Monitoring > Error Logs to see what went wrong.

Support and Troubleshooting

Select the Help button on any iPaaS.com page to contact Support or search the documentation. You can also use the following resources:

For a standalone reference to the connection credentials, subscription settings, authentication methods, and throttling controls, see Connections and Settings. To enable real-time updates from Magento 2, see Mageplaza Webhooks.

Did this answer your question?