Constant Contact Authenticate an Element Instance

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

Authenticate Through the UI

Use the UI to authenticate with Constant Contact and create an element instance. Because you authenticate with Constant Contact via OAuth 2.0, all you need to do is add a name for the instance. After you create the instance, you'll log in to Constant Contact to authorize Cloud Elements access to 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

Authenticating through API is a multi-step process that involves:

Getting a redirect URL. This URL sends users to the vendor to log in to their account.
Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a callback to the specified url with an authorization grant code.
Authenticating the element instance. Using the authorization code from the vendor, authenticate with the vendor to create an element instance at Cloud Elements.

Getting a Redirect URL

Use the following API call to request a redirect URL where the user can authenticate with the API provider. Replace {keyOrId} with the element key, constantcontact.

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Note: If you want to provide your application users with the ability to sign up with Constant Contact, include newUser=True in the query parameters as shown below.

curl -X GET /elements/{keyOrId}/oauth/url?newUser=True&apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Query Parameter	Description
apiKey	The key obtained from registering your app with the provider. This is the Client ID that you recorded in API Provider Setup section.
apiSecret	The secret obtained from registering your app with the provider. This is the Client Secret that you recorded in API Provider Setup section.
callbackUrl	The URL that will receive the code from the vendor to be used to create an element instance.
newUser	Optional. Include `newUser=true` to redirect a user to the account signup page instead of the login page.

Example cURL

curl -X GET \
  'https://api.cloud-elements.com/elements/api-v2/elements/constantcontact/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=constantcontact' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
    "oauthUrl": "https://oauth2.constantcontact.com/oauth2/oauth/siteowner/authorize?response_type=code&client_id=6rja8budeg8gkpq9fhu3g4ha&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget",
    "element": "constantcontact"
}

Authenticating Users and Receiving the Authorization Grant Code

Provide the response from the previous step to the users. After they authenticate, Constant Contact provides the following information in the response:

code
username

Response Parameter	Description
code	The Authorization Grant Code required by Cloud Elements to retrieve the OAuth access and refresh tokens from the endpoint.
username	The Constant Contact user name of the authenticated user.

Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Instance

Use the /instances endpoint to authenticate with Constant Contact and create an element instance. If you are configuring events, see the Events section.

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

To create an element instance:

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

{
  "element": {
    "key": "constantcontact"
  },
  "providerData": {
    "code": "<AUTHORIZATION_GRANT_CODE>"
  },
  "configuration": {
    "oauth.callback.url": "<CALLBACK_URL>",
    "oauth.api.key": "<CONSUMER_KEY>",
    "oauth.api.secret": "<CONSUMER_SECRET>",
    "filter.response.nulls": true
  },
  "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 and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "constantcontact"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.callback.url": "<CALLBACK_URL>",
    "oauth.api.key": "<CONSUMER_KEY>",
    "oauth.api.secret": "<CONSUMER_SECRET>"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in the Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.

Parameter	Description	Data Type
'key'	The element key. constantcontact	string
Name `name`	The name for the element instance created during authentication.	Body
`oauth.callback.url`	The URL where you want to redirect users after they grant access. This is the Callback URL that you noted in the API Provider Setup section.
`oauth.api.key`	The Client ID from Constant Contact. This is the Client ID that you noted in the API Provider Setup section.	string
`oauth.api.secret`	The Client Secret from Constant Contact. This is the Client Secret that you noted in the API Provider Setup section.	string
tags	Optional. User-defined tags to further identify the instance.	string

Example Response for an Authenticated Element Instance

{
  "id": 12345,
  "name": "API for Docs",
  "token": "3sU/S/kZD36BaABPS7EAuSGHF+1wsthT+mvoukiE",
  "element": {
      "id": ,
      "name": "Constant Contact",
      "hookName": "ConstantContactHook",
      "key": "constantcontact",
      "description": "Add a Constant Contact instance to connect your existing or new Constant Contact account to the Marketing Hub, allowing you to manage campaigns, lists, contacts etc. across multiple Marketing Elements. You will need your Constant Contact account information to add an instance.",
      "image": "elements/provider_constantcontact.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": true,
      "authentication": {
          "type": "oauth2"
      },
      "extended": false,
      "hub": "marketing",
      "protocolType": "http",
      "parameters": [ ],
  "elementId": 3929,
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {    },
  "eventsEnabled": false,
  "traceLoggingEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
  "user": {
      "id": 12345
    }
  }
 }