You can authenticate with Act! 365 to create your own instance of the Act! 365 connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionalities offered by the Act! 365 platform.
Authenticate Through the UI
Use the UI to authenticate with Act! 365 and create an connector instance. You will need your API key and Developer key that you identified in the API Provider Setup.
If you are configuring events, see Events.
To authenticate an instance, complete the steps described in Authenticate a Connector Instance (UI). in addition to the base authentication parameters, you must also include:
- API Key - Enter the API key that you identified in the API Provider Setup
- Developer Key - Enter the developer key that you identified in the API Provider Setup
Authenticate Through API
Send a request to our /instances
endpoint to authenticate an instance. When finished note the token and id.
To authenticate an instance:
Construct a JSON body as shown below (see Parameters):
{ "element": { "key": "actessentials" }, "configuration": { "username": "<ACT 365 API key>", "password": "<ACT 365 Developer key>" }, "tags": [ "<Add_Your_Tag>" ], "name": "<INSTANCE_NAME>" }
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.Locate the
token
andid
in the response and save them for all future requests using the connector instance.
Example cURL
curl -X POST
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
"key": "actessentials"
},
"configuration": {
"username": "xxxxxxxxxxxxxxxxxx",
"password": "xxxxxxxxxxxxxxxx"
},
"tags": [
"Docs"
],
"name": "API Instance"
}'
Parameters
Parameter | Description | Data Type |
---|---|---|
key | The connector key. actessentials | string |
Namename | The name of the connector instance created during authentication. | string |
API Keyusername | The Act! 365 API key assigned to the user that you record in the API Provider Setup | string |
Developer Keypassword | The Act! 365 developer key assigned to the user that you record in the API Provider Setup | string |
tags | Optional. 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": "INSTANCE_NAME",
"createdDate": "2019-12-11T07:30:43Z",
"token": "ABC/Dxxxxxxxxxx",
"elementId": 7213,
"tags": [...],
"valid": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"configuration": {...},
"authenticationType": "basic",
"eventsEnabled": false,
"cachingEnabled": false,
"traceLoggingEnabled": false,
"organizationId": 1190,
"accountId": xxxxx,
"externalAuthentication": "none",
"userId": xxxxxx,
"element": {
"id": 7213,
"name": "Act! 365",
"key": "actessentials",
"description": "Add an Act! 365 Instance to connect your existing Act! 365 account to the CRM Hub, allowing you to manage contacts and activities across multiple Elements. You will need your Act! 365 account and Act! 365 API key (available in your Profile > Apps & Integrations section) to add an instance.",
"image": "https://pbs.twimg.com/profile_images/497478802432217088/-NAAUSvt.png",
"logo": "actessentials",
"active": true,
"deleted": false,
"typeOauth": false,
"trialAccount": false,
"resources": [...],
"objects": [...],
"transformationsEnabled": true,
"bulkDownloadEnabled": true,
"bulkUploadEnabled": true,
"cloneable": true,
"extendable": true,
"beta": false,
"authentication": {...},
"extended": false,
"useModelsForMetadata": true,
"hub": "crm",
"protocolType": "http",
"parameters": [...],
"private": false
},
"user": {
"id": xxxxx
}
}