SugarCRM Authenticate an Element

You can authenticate with SugarCRM to create your own instance of the SugarCRM element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the SugarCRM platform.

Authenticate Through the UI

Use the UI to authenticate with SugarCRM and create an element instance. Because you authenticate with SugarCRM via OAuth 2.0, all you need to do is add a name for the instance and provide the account credentials identified in SugarCRM API Provider Setup. After you create the instance, you'll log in to SugarCRM to authorize Cloud Elements to access your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI). 

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

SugarCRM is a CRM system. When you provision an instance, your app will have access to the different functionality offered by the SugarCRM platform.

Step 1. Create an Instance

To provision your SugarCRM element, use the /instances API.

Below is an example of the provisioning API call.

• HTTP Headers: Authorization- User , Organization
• HTTP Verb: POST
• Request URL: /instances
• Request Body: Required – see below
• Query Parameters: none

Description: token is returned upon successful execution of this API. This token needs to be retained by the application for all subsequent requests involving this element instance.

A sample request illustrating the /instances API is shown below.

HTTP Headers:

Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_ORGANIZATION_SECRET>

This instance.json file must be included with your instance request. Please fill your information to provision. The “key” into Cloud Elements SugarCRM is “sugarcrmv2”. This will need to be entered in the “key” field below depending on which element you wish to instantiate. The site URL should be the domain to your SugarCRM only (exclude the http(s)).

Note: oauth.callback.url is optional. The oauth.callback.url is the application URL to return to after the authentication flow at SugarCRM completes.

{
  "element": {
    "key": "sugarcrmv2"
  },
   "configuration": {
       "oauth.api.key": "<INSERT_SUGARCRM_CONSUMER_KEY>",
       "oauth.api.secret": "<INSERT_SUGARCRM_CONSUMER_SECRET>",
       "oauth.callback.url": <INSERT_YOUR_CALLBACK_URL>,
       "site.url": "<INSERT_SUGARCRM_UNIQUE_URL>",
       "username": "<INSERT_SUGARCRM_USERNAME>",
       "password": "<INSERT_SUGARCRM_PASSWORD>",
       "sugar.platform": "<INSERT_SUGARCRM_PLATFORM>",
   },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_NAME>"
}

Here is an example cURL command to create an instance using /instances API.

Example Request:

curl -X POST
-H 'Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_ORGANIZATION_SECRET>'
-H 'Content-Type: application/json'
-d @instance.json
'https://api.cloud-elements.com/elements/api-v2/instances'

If the user does not specify a required config entry, an error will result notifying her of which entries she is missing.

Below is a successful JSON response:

{
  "id": 1234,
  "name": "Test",
  "token": "CxpGZOkJ8BkL4oG3mGSurj8DYiTAUY=",
  "element": {
    "id": 1234,
    "name": "SugarCRM",
    "key": "sugarcrmv2",
    "description": "Add a SugarCRM Instance to connect your existing SugarCRM account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities, etc. across multiple CRM elements. You will need your SugarCRM account information to add an instance.",
    "image": "https://pbs.twimg.com/profile_images/476756189934395393/aqcFdWXX_400x400.jpeg",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": []
  },
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {
    "base.url": "https://{site.url}/rest/v10",
    "oauth.api.secret": "SURGARCRM_CONSUMER_KEY",
    "bulk.query.field_name": "date_modified",
    "site.url": "yourdomain.sugarondemand.com",
    "oauth.token.url": "https://{site.url}/rest/v10/oauth2/token",
    "pagination.max": "100",
    "event.vendor.type": "webhook",
    "oauth.user.token": "OAUTH_USER_TOKEN",
    "bulk.query.operator": ">=",
    "bulk.query.date_mask": "yyyy-MM-dd'T'HH:mm:ssXXX",
    "bulk.attribute.created_time": "date_entered",
    "password": "SUGARCRM_PASSWORD",
    "pagination.type": "offset",
    "event.notification.callback.url": null,
    "oauth.callback.url": "https://console.cloud-elements.com/elements/jsp/home.jsp",
    "oauth.user.refresh_token": "OAUTH_REFRESH_TOKEN",
    "bulk.attribute.modified_time": "date_modified",
    "oauth.user.refresh_interval": "3600",
    "oauth.api.key": "SUGARCRM_API_KEY",
    "oauth.user.refresh_time": "1432311980589",
    "username": "SUGAR_USERNAME",
    "event.notification.enabled": "false"
  },
  "eventsEnabled": false,
  "cachingEnabled": false
}

Note: Make sure you have straight quotes in your JSON files and cURL commands. Please use plain text formatting in your code. Make sure you do not have spaces after the in the cURL command.

Instance Configuration

The content in the configuration section or nested object in the body posted to the POST /instances or PUT /instances/{id} APIs varies depending on which element is being instantiated. However, some configuration properties are common to all elements and available to be configured for all elements. These properties are -

• event.notification.enabled: This property is a boolean property, and determines if event reception (via webhook or polling) is enabled for the element instance. This property defaults to false.
• event.vendor.type: When event.notification.enabled property is set to true, this property determines the mechanism to use to receive or fetch changed events from the service endpoint. The supported values are webhook and polling. Most elements support one mechanism or the other, but some like Salesforce.com support both mechanisms. This property is optional.
• event.notification.type: This property can be used to determine how an event notification should be sent to the consumer of the element instance, in most cases your application. Currently, webhook is the only supported value for this property. This means that when an event is received by the element instance, it will get forwarded to the provided event.notification.callback.url via a webhook to you. This property is optional.
• event.notification.callback.url: As mentioned above, the value of this property is an http or https URL to which we will post the event for consumption by your application. This property is optional.
• filter.response.nulls: This property defaults to true, i.e., it's boolean property, and determines if null values in the response JSON should or should not be filtered from the response returned to the consuming application. By default, all null values are filtered from the response before sending the response to the consuming application.