Before You Begin
Before you begin installing the Adobe Commerce subscription, you need to have your User Name and Password available. You will use these during the integration installation. The API Access Token is available in Adobe Commerce.
There are 2 ways for authenticating, using an Integration Token or using a username/password pair.
You can change the authentication settings by using following steps.
In previous versions of Commerce, the access token could be used on its own for token-based authentication. This behavior has been disabled by default due to the security implications of a never-expiring access token. Namely, if the access token is compromised it provides undetected persistent access to a store.
However, while it is not recommended, this behavior can be restored from the command line interface (CLI) by running the following command:
bin/magento config:set oauth/consumer/enable_integration_as_bearer 1
This configuration can also be achieved by performing the following steps directly in the Magento store.
Click Stores > Configuration.
Click Services and then click OAuth.
Click Save Config to apply the changes.
Creating Integration Token
Log in to Adobe Commerce and select System > Integrations.
Click Add New Integration and enter the Name, Email, and Password.
Click API.and in the the Resource Access drop-down
Select Custom to grant access to specific APIs.
Select All to grant access to all APIs
Click Activate.
Adobe Commerce displays the APIs you have granted access to in a new window. Review the listed permissions carefully, then click Allow.
Adobe Commerce displays a window with the Consumer Key, Consumer Secret, Access Token, and Access Token Secret.
The Access Token can be used in the iPaaS subscription as “Magento2 API Integration Key”.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Adobe Commerce Integration title.
On the Subscription Detail page, click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Adobe Commerce – Release
Select Create Default Mappings (recommended).
If you don’t want to create default mappings and want to create all mappings from scratch by yourself then uncheck this box.
Provide the API URL endpoint for your Adobe Commerce instance.
Environment URLs
Test/Sandbox: https://[your-instance].[product-domain].com
Production: Provided by client
Enter your Magento2 API Username and Magento2 APIKey. These are the User Name and Password you use to log in to Adobe Commerce.
This step is not required when using an Integration Access Token. These credentials should only be used as an alternative to an access token if 2FA has been disabled.Enter the Magento2 API Integration Key. This is the Adobe Commerce Access Token you saved from your Adobe Commerce account.
Enter the Magento Store value. This field defines what appears in the store URL. Currently, the only supported option, all, has been tested with template mapping.
Enter the Inventory Batch Max Size to set the maximum number of inventory records that can be processed at once during inventory sync. This setting helps optimize performance and prevent system overload by limiting the number of items processed in each cycle.
Recommended Values:
Initial Setup: 50
Ongoing Operations: 100
High Volume: 200
For example, if the Inventory Batch Maximum Size is set to 50, only 50 inventory records will be processed at a time, rather than the default of 100.
The Pricing Tier Field Separator specifies the character used to divide individual field values within price data. It ensures that attributes like price, code, description, and unit are correctly identified and mapped when read from a custom field.
The recommended values for initial setup, ongoing operation, and high-volume scenarios is a comma (,).
For example, if the Pricing Tier Separator is set to a comma (,), the string 2000.99, price, fakeSalesCode, null, fakeDescription, MG Testing Unit 9 AA, 1, null, null will be split into separate fields.Set the Pricing Tier Record Delimiter to define the character used to separate multiple price list entries. It ensures that the system can correctly parse and interpret different price records from a single field.
The recommended values for initial setup, ongoing operation, and high-volume scenarios is a pipe(|).
For example, if the PriceListFieldSeparator is set to a pipe (|), the string 2000.99,price,fakeSalesCode,null,fakeDescription,MG Testing Unit 9 AA,1,null,null|600.99,price,fakeSalesCode,null,fakeDescription,MG Testing Unit 9b AA,2,null,null will be split into two distinct price list entries at the pipe.The Shipment Items Field Separator specifies the character used to divide individual shipment item details. It ensures that values like the order item ID and quantity can be correctly extracted and assigned from a single string.
The recommended values for initial setup, ongoing operation, and high-volume scenarios is a comma (,).
For example, if the ShipmentItemsFieldSeparator is set to a comma (,), the string 12345,2 will be split into OrderItemId = 12345 and Qty = 2.Set the Shipment Items Record Delimiter to specify the character used to separate multiple shipment item records. This allows the system to correctly parse and process a list of shipment items from a single string.
The recommended values for initial setup, ongoing operation, and high-volume scenarios is a pipe(|).
For example, if the ShipmentItemsRecordDelimiter is set to |, the string 12345,2|67890,1 will be split into two separate shipment item records: one for OrderItemId = 12345 with Qty = 2, and another for OrderItemId = 67890 with Qty = 1.Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Adobe Commerce can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can be processed for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Click Apply to save the settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation:
Data Sync Test:
Initiate a sample data pull. (To iPaaS.com)
Initiate a sample data push. (From iPaaS.com)
Functionality Test:
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com