SugarCRM Setup

Before you start

In order to avoid login conflicts as explained by SugarCRM, you will need to set up a custom “platform” name in the SugarCRM portal. It is recommended to provide it with a name that describes and identifies how it will be used.

Registering a New SugarCRM “Platform” Value

As an admin in your SugarCRM instance, go to the Administration panel.
Select Configure API Platforms.
Enter a value of your choosing for the new platform and click Add and then Save.

You’ll then provide that Platform value when authenticating a SugarCRM Connector in Cyclr.

Authentication using Cyclr’s API

SugarCRM uses OAuth 2 Password Credentials.

If installing a SugarCRM Connector using Cyclr’s API, your user won’t be automatically directed to the SugarCRM sign-in screen.

Instead, you must manually set the following 3 Account Connector Properties using Cyclr API calls:

Domain
Username
Password

First set the SugarCRM Domain on an Account Connector:

curl -X POST
     -H 'Content-Type: application/json' 
     -H 'Accept: application/json' 
     -d '{
            "Name": "Domain",
            "Value": "myaccount.sugarcrm.eu"
         }'
'https://{CyclrAPIDomain}/v1.0/account/connectors/ACCOUNT_CONNECTOR_ID/properties'

The SugarCRM Domain should be in the format “myaccount.sugarcrm.eu” without “https://” or a final forward slash.

Platform should be the custom platform value you set earlier.

Set up SugarCRM Username and Password as account connector properties:

curl -X POST
     -H 'Content-Type: application/json'
     -H 'Accept: application/json'
     -d '{
            "Name": "Username",
            "Value": "myuser"
         }'
'https://{CyclrAPIDomain}/v1.0/account/connectors/ACCOUNT_CONNECTOR_ID/properties'

curl -X POST 
     -H 'Content-Type: application/json' 
     -H 'Accept: application/json'
     -d '{
            "Name": "Password",
            "Value": "mypassword"
         }'
'https://{CyclrAPIDomain}/v1.0/account/connectors/ACCOUNT_CONNECTOR_ID/properties'

Same as the OAuth Redirect flow, call /UpdateAccountConnectorOAuth with a one-time token. If the Domain, Username and Password are all correctly set up, your end-user will simply be redirected back to your application.

Apply filters to calls

The following methods support the use of additional filters to refine your request:

Get New And Updated Opportunities
Search Opportunities
Search Custom Objects

To apply an additional filte, you can add a custom field to the request with a** Field Location** in the format: field.operator, for example, campaign_name.$contains. You can then supply a value for that field when you make your requests, such as Leads.

The supported filter operators are as follows:

Operator	Description
$equals	Performs an exact match on that field.
$not_equals	Matches on non-matching values.
$starts	Matches on anything that starts with the value.
$ends	Matches anything that ends with the value.
$contains	Matches anything that contains the value.
$in	Finds anything where field matches one of the values as specified as an array.
$not_in	Finds anything where field does not match any of the values as specified as an array.
$is_null	Checks if the field is null. This operation does not need a value specified.
$not_null	Checks if the field is not null. This operation does not need a value specified.
$lt	Matches when the field is less than the value.
$lte	Matches when the field is less than or equal to the value.
$gt	Matches when the field is greater than the value.
$gte	Matches when the field is greater than or equal to the value.

For more information, see the Cyclr documentation on how to add custom fields.