SAP Cloud Platform Open Connectors

Autotask CRM Authenticate A connector Instance

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

Authenticate Through the UI

Use the UI to authenticate with Autotask and create a connector instance as described in Authenticate A connector Instance (UI). In addition to the base authentication parameters, you will need your Username, Password, and Server URL that you identified in API Provider Setup.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated connector instance with a token and id.

To authenticate a connector instance:

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

    {
      "element": {
        "key": "autotaskcrm"
      },
      "configuration": {
        "crm.autotask.username": "<AUTOTASK_USERNAME>",
        "crm.autotask.password": "<AUTOTASK_PASSWORD>",
        "crm.autotask.server.url": "<AUTOTASK_LOGIN_URL>"
      },
      "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": "autotaskcrm"
  },
  "configuration": {
    "crm.autotask.username": "xxxxxxxxxxxxxxxxxx",
    "crm.autotask.password": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "crm.autotask.server.url": "https://ww2.autotask.net"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

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
keyThe connector key.
autotaskcrm
string
Name
name
The name of the connector instance created during authentication.string
Username
crm.autotask.username
The AutoTask Username.string
Password
crm.autotask.password
The AutoTask Password.string
Server URL
crm.autotask.server.url
The AutoTask login URL.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Connector Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 50,
    "name": "Autotask CRM",
    "hookName": "AutotaskCRM",
    "key": "autotaskcrm",
    "description": "Add an Autotask CRM Instance to connect your existing Autotask account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple CRM connectors. You will need your Autotask CRM account information to add an instance.",
    "image": "elements/provider_autotask.png",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "configDescription": "If you do not have an Autotask.com account, you can create one at <a href=\"http://www.autotask.com\" target=\"_blank\">Autotask CRM Signup</a>",
    "signupURL": "http://www.autotask.com",
    "defaultTransformations": [  ],
    "objectMetadata": [  ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": false,
    "extendable": true,
    "beta": false,
    "authentication": {
        "type": "basic"
    },
    "extended": false,
    "hub": "crm",
    "protocolType": "soap",
    "parameters": [  ],
    "private": false
    },
    "elementId": 50,
    "tags": [
      "Docs"
      ],
    "provisionInteractions": [  ],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}