Heartland Installation Instructions
Before You Begin
Before you begin installing the Heartland subscription, you need to obtain an API token from Heartland.
Log in to your Heartland account.
Click your Name and select My Account.
Select the API Tokens tab.
Type a descriptive name for the token.
Click Generate New Token.
Click Copy and save the token in a secure file. You will need to token to complete the integration setup.
With the API token saved, you can begin installing the integration.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Heartland 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: Heartland – Release
Select Create Default Mappings (recommended).
NOTE: If you don’t want to create default mappings and want to create all mappings from scratch by yourself then uncheck this box.Enter the Adjust Empty Gift Card For Payment, which determines whether empty or fully used gift cards should still be adjusted and applied during payment processing into iPaaS.
For example: If gift card balance is 0 and this preset is “true” then gift card will be created with a payment amount. If it is “false”, then gift card will be created with a 0 balance.Enter the Add On Item Limit, specifying the maximum number of related products or variants of product that can be retrieved and associated during To iPaaS flow of Product.
For example: A positive number (e.g., 5) restricts the result to that many related items, while 0 disables fetching related items. If left blank, all matching related items will be retrieved without restrictions.
Enter the Transaction Poll Search Days, specifying the number of past days the system should look back when polling transaction records at first time.
For example: If “7” is provided, then it would fetch the last 7 days' records from the current date and time.
Enter the API Key. This is the API token you retrieved and saved from Heartland.
Provide the API URL endpoint for your Heartland instance.
Format: https://[your-instance]
Example: https://ipaasdev.retail.heartland.us
Environment URLs
Test/Sandbox: https://pimdev.heartwellbrand.com/user/login
Production: N/A
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 Akeneo 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.
Default Value: 5
Range: 10
Click Apply to save the settings.
OAuth 2.0 Flow Initialization
To initiate the OAuth 2.0 Flow and generate an access token:
Go to your Heartland subscription.
Click the Authentication icon found in the top toolbar:
A new browser window opens, requesting permissions for the application.
While logged into Heartland, click Authorize when prompted.
Click Close Page.
Refresh the subscription, and the access token value should now be present if successful.
NOTE: The Heartland OAuth 2.0 access token is a permanent access token and does not expire. |
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.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation. Additional resources include:
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