Skip to main content

SugarCRM Installation Instructions

Step-by-step setup for the SugarCRM integration in iPaaS.com: subscribe, enter credentials, authenticate, enable automatic transfers, and verify.

Before You Begin

Set up the following in SugarCRM before configuring the integration in iPaaS.com:

  • API URL: the address of your SugarCRM REST API, including the API version — for example, demo.sugarcrm.com/rest/v11_25. Enter it without a https:// prefix; the integration always connects over HTTPS.

  • API user: a SugarCRM user with read and write permission for Accounts and Contacts. The integration authenticates as this user and cannot access more than the user can.

  • Scheduled job (cron.php): required only if you plan to use automatic transfers. SugarCRM delivers its Web Logic Hook events through the scheduled cron.php job, so it must be enabled and running on the SugarCRM server. Configure it to run as frequently as possible.

Installation Instructions for Integration Setup

  1. In iPaaS.com, go to Subscriptions, click Search Certified Integration Marketplace, and open the marketplace.

    The iPaaS.com Subscriptions page with the Search Certified Integration Marketplace button highlighted.

  2. Click the SugarCRM integration tile.

    The SugarCRM integration tile.

  3. On the SugarCRM details page, click the Subscribe button.

    The SugarCRM subscription detail page with the Subscribe button.

  4. Enter a Name for the subscription and select a Version. Use a unique, descriptive name.

    • Format: [Product Name] - [Environment/Purpose]

    • Example: SugarCRM - Production

  5. Leave Create Default Mappings selected (recommended). This creates the standard Account and address mapping collections. Uncheck it only if you intend to build all mappings yourself.

  6. Enter the connection details:

    • API URL: your SugarCRM REST API host and version, without the https:// prefix (for example, demo.sugarcrm.com/rest/v11_25).

    • Username: the SugarCRM API user's username.

    • Password: the password for that API user.

    The iPaaS.com SugarCRM subscription settings page showing the Name, Version, API URL, Username, Password, and throttling fields.

  7. Set the throttling values. These are pre-populated and should be reduced only if you encounter SugarCRM rate-limit errors.

    • API Throttle Limit: the number of requests allowed within the throttle window. Pre-populated at 500. Recommended: 5 for the initial bulk load, 500 for ongoing operations and high volume.

    • API Throttle Seconds: the length of the throttle window. Default 60 seconds.

    • Concurrent Connections: the maximum number of simultaneous connections. Default 10.

    • Concurrent Batch Executions: the maximum number of simultaneous batch executions. Default 10.

  8. Click Apply to save the settings.

Authentication Configuration

The SugarCRM integration authenticates with OAuth 2.0, using the SugarCRM API user's credentials. iPaaS.com obtains an access token from SugarCRM using the credentials you enter and refreshes that token automatically as it expires.

Enter these credentials on the subscription settings page:

  • API URL

  • Location: your SugarCRM instance address plus the REST path and version (for example, demo.sugarcrm.com/rest/v11_25), entered without the https:// prefix.

  • Description: the base of the SugarCRM REST API that the integration calls.

  • Username

  • Location: a SugarCRM user (SugarCRM Admin > User Management) with read/write access to Accounts and Contacts.

  • Description: the user the integration authenticates as.

  • Password

  • Location: the password for the API user.

  • Description: used together with the username to obtain the OAuth 2.0 token.

Important Notes: - Enter the API URL without a https:// prefix — the integration always connects over HTTPS. Including the prefix will prevent authentication. - After entering the credentials and clicking Apply, establish the connection so iPaaS.com can validate the credentials against SugarCRM. - iPaaS.com stores and refreshes the OAuth token automatically; you do not need to re-enter credentials unless the SugarCRM user's password changes.

Operational Configuration

Enable automatic transfers (Web Logic Hooks)

Automatic transfers are optional and off until you enable them. To have SugarCRM Account changes flow to iPaaS.com automatically:

  1. In the subscription configuration, open Inbound Data Flows and enable the Accounts event. iPaaS.com provisions the corresponding Web Logic Hook in SugarCRM automatically.

    The subscription's Inbound Data Flows page with the Accounts webhook set to Active.

  2. Ensure the scheduled cron.php job is enabled and running on the SugarCRM server, as SugarCRM delivers Web Logic Hook events through it. Run it as frequently as possible.

Records can also be transferred at any time from the iPaaS.com Manual Sync page without enabling automatic transfers. See the SugarCRM to iPaaS.com Account Mapping Documentation and the SugarCRM from iPaaS.com Account Mapping Documentation for the ID formats to use.

Post-Installation Verification

Connection Test

  1. On the subscription settings page, establish the connection.

  2. Confirm the connection succeeds. If the credentials or API URL are rejected, the connection is not established and the reason is shown; correct them and try again.

Data Sync Test

  1. From the iPaaS.com Manual Sync page, transfer a SugarCRM Account into iPaaS.com (a TO iPaaS.com sync) and confirm a matching Customer appears.

  2. Transfer an iPaaS.com Customer to SugarCRM (a FROM iPaaS.com sync) and confirm the Account is created or updated in SugarCRM.

Functionality Test

  1. Run an end-to-end Account transfer in each direction.

  2. Confirm the field mappings, the primary contact, and the billing and shipping addresses populate as expected.

  3. Review the transfer results under Dashboard / Integration Monitoring / Error Logs.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or search the documentation.

For SugarCRM-side questions (API access, user permissions, cron.php), see the SugarCRM Developer Guide — REST API.

Related Documents

Related Articles
Did this answer your question?