Authenticate with Constant Contact

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. Constant Contact authentication follows the typical OAuth 2 framework and you will need to sign in to Constant Contact as part of the process.

If you are configuring events, see the Events section.

To authenticate an element instance:

1. Sign in to Cloud Elements, and then search for Constant Contact in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. If you do not already have a Constant Contact account, click Show Optional Fields, and then choose true for New User.
5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
6. Click Create Instance.
7. Provide your Constant Contact credentials, and then allow the connection. If you are a new user, sign up.

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>

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

Query Parameters

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

Authenticating the Element Instance

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

To create an element instance:

1. 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>"
   }
   

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. See the Overview for details.

3. 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.

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
    }
  }
 }