Skip to main content

SugarCRM

Overview​

The SugarCRM connector uses the REST Web service API to connect giving users the ability to make use of SugarCRM's capabilities for customer management and support as well as sales and marketing automation .

Configuration​

In order to connect to the Data Hub connector, the following four configuration steps are required within SugarCRM. You need an admin user to be able to complete these steps.

  1. Identify the latest REST API version for your SugarCRM release
  2. Authorize a Zap API identifier
  3. Setup OAuth key credentials
  4. Create a user

Identify the latest REST API version for your SugarCRM release​

When connecting to your SugarCRM instance, we require the REST API version tied to your SugarCRM release. This can be found through Sugar's Web Services article:

Determine your REST API version

Authorize a Zap API Identifier​

Data Hub requires configuring a platform identifier in Sugar CRM for the API integration. To setup the API platform identifier, please follow these steps:

  1. From the dashboard, navigate to the top-right and click on Admin.

  2. On the Administration page, navigate to the Developer Tools section and click on Configure API Platforms.

  3. At the bottom, add the Zap API platform identifier and click Add.

  4. Click Save.

Setup OAuth key credentials​

The SugarCRM connector requires a Client Id and Client Secret to authenticate against your SugarCRM instance. To setup the OAuth credentials, please follow these steps:

  1. From the dashboard, navigate to the top-right and click on Admin.

  2. On the Administration page, navigate to the System section and click on OAuth Keys.

  3. On the OAuth Consumer Keys page, on the toolbar, click Create OAuth Key.

  4. On the Create page, input values for the following mandatory fields:

    1. Consumer Key Name.

    2. Consumer Key and Consumer Secret.

      important

      Make sure to save these values as you will need them for the Data Hub SugarCRM connection.

    3. For OAuth version, select OAuth 2.0.

    4. For Client Type, select Sugar User.

  5. Click Save.

Create a user​

It is best practice to create a user with the minimum required permissions to access your SugarCRM instance. Since a user requires assigning a license, you can use an existing user, though ensure they have the permissions you require for your case.

To create a user, please follow these steps:

  1. From the dashboard, navigate to the top-right and click on Admin.

  2. On the Administration page, navigate to the Users section and click on User Management.

  3. On the Users page, click on Create.

  4. On the Create page, input values for the following mandatory fields:

    1. Username
    2. First Name
    3. Last Name
    4. Email
    5. For Status, select Active.
    6. For User Type, select Regular User. This can be set to System Administrator User if you do not want to configure permissions using roles.
    7. Assign the appropriate licenses.

  5. Click Save.

  6. Once created, this user will need to click the Forgot Password link on the login page to create a password.

Create a role​

  1. From the dashboard, navigate to the top-right and click on Admin.

  2. On the Administration page, navigate to the Users section and click on Role Management.

  3. On the Roles page, on the toolbar, click on Create Role.

  4. On the Create page, add a Name and click Save.

  5. On the newly created Role page, assign the appropriate permissions where applicable and assign it to the user you wish to use to connect to SugarCRM.

    note

    You must Enable the applicable modules access and set the access type to Normal

Connecting to the data source​

Connection details:      

  • URL: Your SugarCRM instance. For Example. https://sugartest.demo.sugarcrm.eu/
  • Username: The username of the user that will be used to authenticate SugarCRM.
  • Password: The password of the user that will be used to authenticate SugarCRM.
  • API Version: The REST API version identified earlier.
  • Client Id: The Consumer Key created through setting up the OAuth key credentials on your SugarCRM instance
  • Client Secret: The Consumer Secret created through setting up the OAuth credentials on your SugarCRM instance.

Supported versions​

The SugarCRM data source models all module endpoints exposed through SugarCRM's REST API's metadata endpoint. This currently includes built-in modules and custom-built modules created through the module builder.

Currently, we support:

  • SugarCRM Release 7.7.x and higher

  • Verified to work with Sugar Sell Premier and Sugar Serve. License types.