SAP Cloud Platform Open Connectors

MailChimp v3.0 Authenticate A connector

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

Authenticate Through the UI

Use the UI to authenticate with MailChimp and create a connector instance. Because you authenticate with MailChimp 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 MailChimp to authorize SAP Cloud Platform Open Connectors access to your account. For more information about authenticating a connector instance, see Authenticate A connector 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 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.

Authenticating through API follows a multi-step OAuth 2.0 process that involves:


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Getting a Redirect URL


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


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

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<MailChimp Key Name>&apiSecret=<MailChimp Secret Name> &callbackUrl=<MailChimp Callback URL Name>

Query Parameters

Query ParameterDescription
apiKeyThe API key or client ID obtained from registering your app with the provider. This is the Key Name that you recorded in API Provider Setup.
apiSecretThe client secret obtained from registering your app with the API provider. This is the Secret Name that you recorded in API Provider Setup.
callbackUrlThe URL that the API provider returns a user to after they authorize access. This is the Callback URL Name that you recorded in API Provider Setup.

Example cURL

curl -X GET \
'https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/elements/mailchimpv3/oauth/url?apiKey=Rand0MAP1-key&apiSecret=fak3AP1-s3Cr3t&callbackUrl=https:%3A%2F%2Fwww.mycoolapp.com%2auth' \

Example Response

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

{
"oauthUrl": "https://login.mailchimp.com/oauth2/authorize?response_type=code&redirect_uri=https:%3A%2F%2Fwww.mycoolapp.com%2auth&state=mailchimpv3&client_id=Rand0MAP1-key",
"element": "mailchimpv3"
}

Authenticating Users and Receiving the Authorization Grant Code


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


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

  • code
  • state
Response ParameterDescription
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. SAP Cloud Platform Open Connectors uses the code to retrieve the OAuth access and refresh tokens from the endpoint.
stateA customizable identifier, typically the connector key (mailchimpv3) .
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 Connector Instance


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the /instances endpoint to authenticate with MailChimp 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 authenticate a connector instance:

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

    {
      "element": {
        "key": "mailchimpv3"
      },
      "providerData": {
        "code": "<AUTHORIZATION_GRANT_CODE>"
      },
      "configuration": {
        "oauth.api.key": "<MailChimp v3.0 app Key Name>",
        "oauth.api.secret": "<MailChimp v3.0 app Secret Name>",
        "oauth.callback.url": "<MailChimp v3.0 app Callback URL Name >"
      },
      "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": "mailchimpv3"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.api.key": "Rand0MAP1-key",
    "oauth.api.secret": "fak3AP1-s3Cr3t",
    "oauth.callback.url": "https;//mycoolapp.com"
  },
  "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.
mailchimpv3
string
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. SAP Cloud Platform Open Connectors uses the code to retrieve the OAuth access and refresh tokens from the endpoint.string
Name
name
The name of the connector instance created during authentication.string
oauth.api.keyThe API key or client ID obtained from registering your app with the provider. This is the Key Name that you noted in API Provider Setup.string
oauth.api.secretThe client secret obtained from registering your app with the API provider. This is the Secret Name that you noted in API Provider Setup.string
oauth.callback.urlThe API key or client ID obtained from registering your app with the provider. This is the Callback URL Name that you noted in API Provider Setup.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": "Instance via API",
  "createdDate": "2017-11-30T21:53:35Z",
  "token": "ABC/D...xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 527,
      "name": "MailChimp v3.0",
      "hookName": "mailchimpv3",
      "key": "mailchimpv3",
      "description": "Mailchimp v3.0 APIs - with Events and Custom Fields.",
      "image": "http://www.smallbiztriage.com/wp-content/uploads/2013/11/mailchimp-logo.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": true,
      "beta": false,
      "authentication": {
          "type": "oauth2"
      },
      "extended": false,
      "hub": "marketing",
      "protocolType": "http",
      "parameters": [  ]
    },
    "elementId": 527,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "providerData": {
        "code": "77f0cf0256edbd4205bf3b269cbe3881"
    },
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 123456,
        "emailAddress": "claude.elements@cloud-elements.com",
        "firstName": "Claude",
        "lastName": "Elements"
    }
}