Sugar Market

Authentication Prerequisites

The Sugar Market element uses the Basic authentication workflow. Before you can authenticate an instance of the Sugar Market element, you would primarily require the API Username and Password, for which you will need to contact the Sugar Market team. For more details on the same, read about Authentication in Sugar Market API Documentation.

Provider sandbox

A Sugar Market account and sandbox are required. Only 'Administrator' accounts can generate the credentials required to authenticate with the element. 

There are default values provided by Sugar for API username and password. The only parameters required by the user are:

• Sugar Market Site URL 
• Username 
• Password

Required Authentication Parameters

You can authenticate an element instance using the UI or via API calls. For detailed information on how to authenticate an instance, see our related documentation:

• Authenticate an Element Instance (UI)
• Authenticate an Element Instance (API)

To authenticate an instance of the Sugar Market element, you will need the following parameters:

Sample Configuration JSON

"configuration": {
    "site.url": "http://my-sugar-market-url.com",
    "username": "MyUsername",
    "password": "MyPassw0rd"
  }

Optional Authentication Parameters

Element Fact Sheet and Reference

Authentication and Configuration Parameters

To see all authentication parameters for the Sugar Market element, follow these steps:

1. Sign in to Cloud Elements and navigate to Elements.
2. Hover over the card for an element, and then click My Resources. 
3. In the top navigation toolbar, click Setup.
4. From the Setup page, you can view a complete list of the element's authentication and configuration parameters.

Element Resources

In order to provide users with normalized APIs across Hubs, Cloud Elements resources were mapped to the following Vendor resources.

Streamlining Patterns in some Resources

Sugar Market API has patterns across some of its resources, that is, the resources shown in the table below follow the pattern of /campaigns/email/{PK}/{action} where PK is the primary key or object id of the object.
In our implementation we built the same where action is a parameter. So, we have GET and POST on /campaigns/email/{PK}/{action} to support all the actions as stated below. (actions=lists,schedule,recall and so on...)

Events and Supported Resources

The Sugar Market element supports events via polling. For detailed information about our Events framework and how to configure an element instance with events, see our documentation:

• Authenticate an Element Instance with Events (UI)
• Authenticate an Element Instance with Events (API)

You can set up polling events for the following resources of the Sugar Market element:

• accounts
• contacts
• legacyPages
• events

Example data for an event created for Sugar Market element

{
  "id": "Af39j449iEFidDeh1ua6",
  "status": "NOTIFIED",
  "timestamp": "Tue Nov 17 2020 06:55:22 pm",
  "accountId": 16271,
  "element": "sugarmarket",
  "elementInstance": "879101",
  "error": "",
  "providerData": {
    "accounts": [
      {
        "account": "https://developer.salesfusion.com/api/2.0/accounts/388/",
        "account_id": 388,
        "account_name": "Kamba",
        "billing_city": "Cupertino",
        "contacts": "https://developer.salesfusion.com/api/2.0/accounts/388/contacts/",
        "created_by": "https://developer.salesfusion.com/api/2.0/users/4/",
        "created_by_id": 4,
        "created_date": "2020-11-17T18:55:00Z",
        "eventType": "CREATED",
        "key_account": false,
        "objectId": "388",
        "owner": "https://developer.salesfusion.com/api/2.0/users/1/",
        "owner_id": 1,
        "phone": "",
        "updated_by": "https://developer.salesfusion.com/api/2.0/users/4/",
        "updated_by_id": 4,
        "updated_date": "2020-11-17T18:55:00Z"
      }
    ],
    "instance_id": 879101,
    "objectType": "accounts",
    "pollDate": 1605639297882
  },
  "eventElementInstances": [
    {
      "eventId": "AXXXj7pFlliXZYNYlua6",
      "elementInstanceId": 879101,
      "userId": 18375,
      "accountId": 16271,
      "notificationId": 149215795,
      "notifiedData": {
        "accountId": 16271,
        "companyId": 6812,
        "elementKey": "sugarmarket",
        "eventId": "AXXXj7pFlliXZYNYlua6",
        "events": [
          {
            "objectType": "accounts",
            "objectId": "388",
            "pollDate": "2020-11-17T18:54:57Z",
            "eventType": "CREATED",
            "elementKey": "sugarmarket",
            "hubKey": "marketing"
          }
        ],
        "instanceId": 879101,
        "instanceName": "Demo",
        "instanceTags": [
          "Demo"
        ],
        "instance_id": 879101,
        "raw": {
          "accounts": [
            {
              "account": "https://developer.salesfusion.com/api/2.0/accounts/388/",
              "account_id": 388,
              "account_name": "Kamba",
              "billing_city": "Cupertino",
              "contacts": "https://developer.salesfusion.com/api/2.0/accounts/388/contacts/",
              "created_by": "https://developer.salesfusion.com/api/2.0/users/4/",
              "created_by_id": 4,
              "created_date": "2020-11-17T18:55:00Z",
              "key_account": false,
              "owner": "https://developer.salesfusion.com/api/2.0/users/1/",
              "owner_id": 1,
              "phone": "",
              "updated_by": "https://developer.salesfusion.com/api/2.0/users/4/",
              "updated_by_id": 4,
              "updated_date": "2020-11-17T18:55:00Z"
            }
          ],
          "eventHeaders": {
            "Raw-Element-Key": "sugarmarket",
            "encodedid": "ODc5MTAx",
            "id": "879101"
          },
          "objectType": "accounts",
          "pollDate": 1605639297882
        },
        "userId": 18375
      },
      "createdDate": "2020-11-17T18:55:22Z",
      "updatedDate": "2020-11-17T18:55:22Z",
      "objectIds": [
        {
          "value": "388"
        }
      ]
    }
  ]
  }

Bulk

Bulk provides an option to upload a large number of resources, such as contacts, to a service provider all at once. You can use bulk to download a csv or json file from a large number of records or upload a csv or json file to add multiple records. See Using Bulk for more information on managing bulk.

Bulk Details

Querying

The Cloud Elements Query Language ( CEQL ) provides a standard way to search across all of our elements. Rather than having users research how to query each resource at a provider, we've normalized your search experience. Cloud Elements translates your queries to the API provider's search syntax. CEQL represents the "where" portion of a typical query that can include many other components like field selection, sorting, and pagination. For more details on Querying, see Querying with CEQL.

To determine whether where clause is supported for an object, you can make an API call to object/{objectName}/metadata while providing the Element version and check for "filterable"="true". In the example shown below, we're checking it for the object - accounts.

A few examples for the usage of where clause would be:

• /accounts?where=account_id='385'
• /accounts?where=account_name='BulkUploadTest'
• /accounts?where=created_date>'2020-07-02T13:41:00Z' 
• /accounts?where=account_name='test' and billing_city='Cupertino'

And shown below is a short video on how to make an API call using the where clause.

There are several operators that are valid to be used for querying. You can find more details on them here. But each object which has "filterable"="true",  can also tell you what operators can be used for that particular filterable, as shown below.

Element Extension

Element Builder gives you the integration tools to extend the current feature set of any of our elements by adding a resource or method. If your use case requires a resource our element doesn’t currently support, you can easily add it in yourself using Element Builder.

Sugar Market is an extendable element and therefore, you can customize it according to your needs. For more details, read the Extend Elements article which gives a description in detail as to how it can be done.

Discovery APIs

Discovery APIs  are usually used in conjunction with a specific authenticated element instance to:

• Identify data objects in aan element
• Identify data objects and their source (the vendor, a VDR, or Cloud Elements library)
• Find metadata, including custom fields, related to an object
• Retrieve the Open API specifications (API docs) of an object

However, Discovery APIs are not supported by Cloud Elements for the Sugar Market element, as there is no support by the vendor for the same.

Element API Documentation

The base URL for all API requests is https://api.cloud-elements.com/elements/api-v2.

Provider Documentation

• Sugar Market API Documentation