Skip to main content

Adobe Commerce/Magento 2 Connections and Settings

Reference for the Adobe Commerce/Magento 2 connection settings in iPaaS.com: every field, how authentication works, the available presets, and how to rotate credentials.

Integrate iPaaS.com with Adobe Commerce/Magento 2 to enable seamless data synchronization for orders, products (configurable and simple), product variants, inventory, categories, inventory locations, customers, gift cards, and deposit and gift-card tickets.

This article is a standalone configuration reference for the Adobe Commerce/Magento 2 integration. Use it when first connecting the integration, and afterward when rotating credentials, moving between environments, or onboarding new team members.

How to Connect

Prerequisites

Before configuring the integration in iPaaS.com, set up the following in your Adobe Commerce/Magento 2 store:

  • A Magento 2 Integration and access token. In the Magento Admin, go to System > Extensions > Integrations, create a new integration, and grant it the resource access the integration needs (full access is recommended). After saving, open the integration and select Activate to generate the credentials. Magento's own guidance for creating an integration is published in the Adobe Commerce integrations documentation. This access token is the credential used by the standard connection method described below.

  • A reachable Magento 2 REST API. The store's REST API must be operational and reachable from iPaaS.com. Confirm the API works as described in the Adobe Commerce web API documentation.

  • The store's base URL. The public URL of your Magento 2 store, used to build the API address.

  • A store scope. The integration operates against the store scope set on the subscription. The value all is the standard, supported scope.

If you plan to 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. Webhook configuration is covered separately during installation and is not part of this connection reference.

Generating an integration access token in the Magento Admin, under System, Extensions, Integrations. The credential values are redacted.

Configuration Details

The credentials you enter in iPaaS.com come from the Magento 2 Integration you created above:

  • Magento2 Api Url: The base URL of your Magento 2 store. Enter the store's public address. Example: https://

  • Magento2 Api Integration Key: The Access Token generated by the Magento 2 Integration. Paste the access token value into this field. Treat it as a secret and do not share it. Example: your-integration-access-token

  • Magento2 Api Username and Magento2 Api Key: The Magento admin username and password, used only if you connect with username and password instead of an access token (see Authentication Methods below).

Configure Subscription Settings

Configure the following settings on the Adobe Commerce/Magento 2 subscription in iPaaS.com. Field names below match the labels shown on the subscription settings page.

The Adobe Commerce/Magento 2 subscription settings page in iPaaS.com, where the connection values are entered. The credential values are redacted.

Field

Description

Required

Example

Magento2 Api Url

The base URL of your Magento 2 store. The integration builds its API address from this value.

Yes

https://

Magento2 Api Integration Key

The Magento 2 Integration access token, used as the standard credential to authenticate API calls.

Conditional: required unless you connect with OAuth or with a username and password.

your-integration-access-token

Magento2 Api Username

The Magento admin username, used only for username-and-password authentication.

Conditional: required only when authenticating with a username and password.

Magento2 Api Key

The Magento admin password, used only for username-and-password authentication.

Conditional: required only when authenticating with a username and password.

your-admin-password

Magento Store

The Magento store scope the integration operates against. Set this to all, which is the supported scope.

No

all

Version

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

No

2.3.6

Auto-Ship Days

Sets a default number of days used when automatically shipping orders, where that behavior is configured.

No

3

Inventory Batch Max Size

Caps the number of inventory records the integration sends in a single inventory batch. Leave blank to use the integration's default batching.

No

5

Concurrent Batch Executions

Sets how many batches the integration processes at the same time. When left blank, the integration uses a default of 10.

No

5

Pricing Tier Field Separator

The character that separates the fields within a single tier-pricing entry when tier prices are supplied as delimited text. Pre-populated by the integration preset.

No

,

Pricing Tier Record Delimiter

The character that separates one tier-pricing entry from the next when tier prices are supplied as delimited text. Pre-populated by the integration preset.

No

|

Shipment Items Field Separator

The character that separates the fields within a single shipment-item entry when shipment items are supplied as delimited text. Pre-populated by the integration preset.

No

,

Shipment Items Record Delimiter

The character that separates one shipment-item entry from the next when shipment items are supplied as delimited text. Pre-populated by the integration preset.

No

|

Bypass Inventory Check On Tracking Upload

When set to true, the integration skips the inventory availability check when uploading shipment tracking. Defaults to false when left blank.

No

false

Authentication Methods

The integration supports three ways to authenticate to Magento 2. Choose the one that matches how your store issues credentials.

  • Integration access token (standard). Enter the Magento 2 Integration access token in the Magento2 Api Integration Key field. iPaaS.com sends this token as a bearer token on every API request. This is the recommended method and is the one used by most subscriptions. For the token to be accepted as a bearer token, your Magento store must allow OAuth access tokens to be used as standalone bearer tokens (a store-level Magento setting configured during installation).

  • OAuth 1.0a. iPaaS.com can authenticate with a full set of OAuth 1.0a credentials, a consumer key, consumer secret, access token, and access token secret, when those values are provided for the connection. Each request is signed with these credentials.

  • Username and password. Enter the Magento admin credentials in the Magento2 Api Username and Magento2 Api Key fields. iPaaS.com exchanges them for a short-lived admin token, which Magento issues with a default lifetime of about four hours; iPaaS.com refreshes it automatically as needed.

Whichever method you use, iPaaS.com validates the connection when you save the subscription by making a live read against your store. If the credentials are missing or invalid, the subscription reports a connection error.

Initialization Support

Initialization (bulk import of existing data on first connect) is not supported for Adobe Commerce/Magento 2 in iPaaS.com. Records transfer on demand and in response to events and scheduled activity once the integration is configured. All data synchronization and mappings must be configured during the integration setup.

Throttling

Throttling protects your Magento 2 store and iPaaS.com from being overwhelmed by too many API calls during heavy data transfers. The throttle fields are required, but they are pre-populated by the integration settings, so in most cases you do not need to change them. For a full explanation of how these fields work, see Subscription Configuration – Edit.

Each throttle is expressed as a limit paired with a number of seconds: the integration allows up to the stated number of calls within each window of that many seconds.

Field

Description

Example

API Throttle Limit

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

2000

API Throttle Seconds

The length, in seconds, of the throttle window applied to calls made to Magento 2.

30

API Throttle Limit (To iPaaS)

The maximum number of calls made into iPaaS.com within each throttle window.

9999

API Throttle Seconds (To iPaaS)

The length, in seconds, of the throttle window applied to calls made into iPaaS.com.

60

Concurrent Connections

The number of simultaneous connections the integration is allowed to open. A value of 0 uses the platform default.

0

The Concurrent Batch Executions setting in the subscription settings table above works alongside these throttles by limiting how many batches the integration runs at once. Subscribers or their MiSP should keep the pre-populated throttle values unless iPaaS.com Support advises otherwise.

Did this answer your question?