SAP Cloud Platform Open Connectors

Sage CRM Authenticate A connector

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

Authenticate Through the UI

Use the UI to authenticate with Sage CRM and create a connector instance as described in Authenticate A connector Instance (UI). In addition to the base authentication parameters, you will need the credentials that you identified in API Provider Setup.

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

Use the /instances endpoint to authenticate with Sage CRM and create a connector instance. If you are configuring events, see the Events section.

Note: The endpoint returns a connector instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this connector instance.

To create a connector instance:

  1. Construct a JSON body as shown below (see Parameters):

    {
      "element": {
        "key": "sagecrm"
      },
      "configuration": {
        "subdomain": "sagecrm-0.<YOUR_TENANT>.com",
        "username": "<YOUR_USERNAME>",
        "password": "<YOUR_PASSWORD>"
      },
      "tags": [
        "<Add_Your_Tag>"
      ],
      "name": "<INSTANCE_NAME>"
    }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the connector instance.

Example cURL

curl -X POST \
  https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
    "element": {
    "key": "sagecrm"
    },
    "configuration": {
        "subdomain": "sagecrm-0.cloud-elements.com",
        "username": "XXXXXX",
        "password": "XXXXXXXXXX"
    },
    "tags": [
     "Docs"
    ],
    "name": "SageCRM"
  }
  '

Parameters

API parameters not shown in SAP Cloud Platform Open Connectors are in code formatting.

Note: Event related parameters are described in Events.
ParameterDescriptionData Type
'key'The connector key.
sagecrm
string
Name
name
The name for the connector instance created during authentication.string
Subdomain
subdomain
The subdomain portion of your Sage CRM URL, excluding HTTPS://string
Username
username
Your Sage CRM user name.string
Password
password
Your Sage CRM password.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response

{
  "id": 427902,
  "name": "SageCRM",
  "createdDate": "2017-06-12T14:09:00Z",
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "element": {
      "id": 3641,
      "name": "Sage CRM",
      "key": "sagecrm",
      "description": "Add a Sage CRM  Instance to connect your existing Sage account to the SageCRM Hub, allowing you to manage accounts, contacts, leads, opportunities, and users, etc. across multiple Sage connectors. You will need your Sage CRM account information to add an instance.",
      "image": "/elements/provider_sagecrm.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ]
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": false,
      "authentication": {
          "type": "basic"
        },
      "extended": false,
      "hub": "crm",
      "protocolType": "http",
      "parameters": [],
      "private": false
    },
    "elementId": 3641,
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration":  {
        "base.url": "https://{subdomain}/sdata/crmj/sagecrm2/-",
        "bulk.add_metadata": null,
        "bulk.query.field_name": "replaceMe",
        "pagination.max": "200",
        "bulk.accounts.attribute.created_time": "Comp_UpdatedDate",
        "event.vendor.type": "polling",
        "bulk.query.operator": ">=",
        "bulk.query.date_mask": "yyyy-MM-dd'T'HH:mm:ss'Z'",
        "bulk.query.download_format": "JSON",
        "password": "********",
        "bulk.contacts.attribute.created_time": "Pers_UpdatedDate",
        "pagination.type": "cursor",
        "bulk.relations": null,
        "event.poller.refresh_interval": "15",
        "event.notification.callback.url": null,
        "subdomain": "sagecrm-0.cloud-elements.com",
        "bulk.leads.attribute.created_time": "Lead_UpdatedDate",
        "bulk.users.attribute.created_time": "User_UpdatedDate",
        "bulk.opportunities.attribute.created_time": "Oppo_UpdatedDate",
        "bulk.query.update": "true",
        "event.poller.configuration": "{ }",
        "username": "xxxxx",
        "event.notification.enabled": "false"
    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 160673
    }
}