Before You Begin
Before you can install the OroCommerce subscription, you need to get the Client Secret, Client ID, and Redirect URL from the OroCommerce Admin panel. To do this, you need to create an OAuth application in the OroCommerce back-office admin panel.
To Create an OAuth Application
Log in to the OroCommerce back-office (admin panel).
Navigate to System > User Management > OAuth Applications.
Click Create OAuth Application in the top right.
Select the Organization and click Continue.
Fill in the Create OAuth Application page with the following:
Application Name: give it a descriptive name (e.g., your integration name).
Active: check this option.
Grant Type: select the appropriate type (typically "Authorization Code" if you need a Redirect URL)
Redirect URLs: this field appears when you select "Authorization Code" as the grant type; enter the URL(s) where users should be redirected after authorization.
Click Save and Close (or Create).
Copy Your Credentials
After saving, OroCommerce displays a dialog with your Client ID and Client Secret. Click the copy icon next to each and save these.
NOTE: The Client Secret is only shown once after creation. You won't be able to view it again later, so save it somewhere secure immediately. |
Installation Instructions for Integration Setup
Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the OroCommerce integration tile.
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: OroCommerce – Release
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings, then un-check this box.
Enter the API URL endpoint. The OroCommerce API URL is instance-based and different for all instances.
Environment URLs:
Test/Sandbox:
https://yourdomain.oro-cloud.comProduction:
https://yourdomain.oro-cloud.com
Enter the Admin Base Path, the root URL path to your OroCommerce backend administration interface. This is used to construct API endpoint URLs. For example,
https://yourdomain.com/adminorhttps://yourdomain.orocloud.com/adminEnter the Client Secret, retrieved above in the Before You Begin section.
Enter the Redirect URL, the callback URL where OroCommerce sends the user (with the authorization code) after successful OAuth authentication. For example:
https://stagingportal.iPaaS.com/customer/subscription-mgmt/subscriptions/authorization/appEnter the number of Client ID, retrieved above in the Before You Begin section.
Under Auto Create Product, select True or False. When True, products referenced in incoming product pricing are automatically created in OroCommerce if they don't already exist. When False, the sync fails records referencing unknown products.
Under Auto Create Customer Group, select True or False. When True, customer groups referenced in incoming price lists, customer groups are automatically created in OroCommerce if they don't exist. When False, the sync fails records referencing an unknown customer group.
Under Default Pricing Custom Field Name, select True or False. When True, this will create and update a product’s default pricing. It must include the entity field name of a boolean-type field from the Oro Commerce Product Price module.
This boolean field is required to explicitly identify whether a given price record represents the default price for the product. The preset relies on this field to distinguish the default pricing entry from other pricing records during synchronization and update operations.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 the subscription 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 process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the setting
OAuth Authentication
To initiate the OAuth 2.0 Flow and generate an access token:
Go to your OroCommerce Subscription Settings.
Click the Authentication icon :
Enter your OroCommerce login credentials.
While logged into OroCommerce, click Authorize when prompted.
On the next page, click Close Page.
Refresh the subscription, and the access token value should now be present.
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.