Skip to main content

How do I integrate with SugarCRM?

Integrate with SugarCRM to sync data and visualize it in SalesScreen.

Written by Simon Hordvik

Note
You need admin privileges in both SalesScreen and SugarCRM to complete this setup.

Prerequisites

There are two requirements for this integration:

  • A SalesScreen Pro or SalesScreen Enterprise subscription

  • A SugarCRM Online subscription

SalesScreen does not support integration with SugarCRM on premise installations.

How the integration works

The integration uses the OAuth 2.0 protocol. You authorize SalesScreen to retrieve data from SugarCRM on behalf of your organization.

Before you initialize the integration from SalesScreen, you must configure a few settings in SugarCRM and note these three values:

  • Your SugarCRM base URL

  • Your SalesScreen Consumer Key

  • Your SalesScreen Consumer Secret

Configure settings in SugarCRM

Sign in to SugarCRM as an administrator.

Turn off IP validation

SalesScreen can use several IP addresses during a session. IP validation in SugarCRM can therefore block data access. To avoid this, disable IP validation.

  1. Go to Administration > System Settings.

  2. Find the Validate user IP address setting and disable it.

  3. Click Save.

(No screenshot provided for this step.)

Allow SalesScreen to access the REST API

By default, SugarCRM only allows REST API access for known platform types. You must add salesscreen as an allowed platform.

  1. Go to Administration > Configure API Platforms.

  2. In the text field at the bottom of the list, type salesscreen and click Add.

  3. Confirm that salesscreen now appears in the list, then click Save.

Get the base URL

  1. While logged in to SugarCRM, look at the browser address bar.

  2. Example URL:

    https://myorganization.sugaropencloud.com/#Home/abc

  3. Copy only the main part, in this example:

    https://myorganization.sugaropencloud.com

This is your SugarCRM base URL.

Create OAuth credentials in SugarCRM

  1. In Administration, click OAuth Keys under the System section.


    ​

  2. Click Create OAuth Key.


    ​

  3. In the creation view, fill in the fields:

    • Consumer Key Name: SalesScreen

    • Consumer Key: a random string of letters and numbers.The best way to generate this is to use a GUID generator.

    • Consumer Secret: another random string of letters and numbers, different from the key

    • OAuth Version: set to OAuth 2.0

    • Client Type: set to Sugar User

  4. Copy or write down the Consumer Key and Consumer Secret values.

  5. Click Save to complete creation of the SalesScreen OAuth key.

You now have all three required values:

  • SugarCRM base URL

  • SalesScreen Consumer Key

  • SalesScreen Consumer Secret

Initialize the integration in SalesScreen

Sign in to SalesScreen with an admin user account.

  1. Click Manage at the bottom left, then select Settings.

    • If you do not see Manage, you are not signed in as an admin.

  2. Go to Integrations and click Integrate for SugarCRM.


    ​

  3. In the SugarCRM Integration form, enter the five values:

    • Username – your SugarCRM username

    • Password – your SugarCRM password

    • Base URL – the base URL you copied from SugarCRM

    • Consumer Key – from the OAuth key you created

    • Consumer Secret – from the OAuth key you created

SalesScreen does not store your SugarCRM password permanently. It is used only by the OAuth 2.0 flow to complete authorization.

  1. Click Integrate.

If everything is configured correctly, you are redirected to the SugarCRM Integration management dashboard after a short moment.


​

Manage the SugarCRM integration

From now on you can go to:

Manage > Settings > Integrations > Manage SugarCRM

From the integration dashboard you can:

  • Pause or resume synchronization

  • Terminate the integration

  • Create subintegrations that define exactly which SugarCRM data is synchronized to SalesScreen

Did this answer your question?