Mailchimp Connector
Documentation
Version: 1
Documentation

How to read data from Mailchimp in SSIS (Export data)


In this section we will learn how to configure and use Mailchimp Connector in the API Source to extract data from the Mailchimp.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Mailchimp Connector from Popular Connector List or press Search Online radio button to download Mailchimp Connector. Once downloaded simply use it in the configuration:

    Mailchimp
    Mailchimp Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Steps to get Mailchimp Credentials
    To get the credentials you need in order to set up your OAuth workflow, you'll first need to register your application with Mailchimp:
    1. Navigate to the Registered Apps page in your Mailchimp account.
    2. Click Register An App.
    3. Fill out the Register An App form.
    4. Click Create.
    5. After successfully registering your application, you'll see the client_id and client_secret at the bottom of the page - record these values and store them securely.
    6. Record your Mailchimp data center, since we will need it later. The data center will be located in your browser's address bar URL. If the URL is "https://us21.admin.mailchimp.com/account/api/", then your data center is "us21".
    7. Back at the connector screen, enter the data center that was recorded in step 6 into the Data Center field.
    8. Enter the client_id value that was recorded in step 5 into the Client Id field.
    9. Enter the client_secret value that was recorded in step 5 into the Client Secret field.
    10. Click Generate Token. If proper authentication occurs, you will see a notice saying so. If you get any errors, click Yes on the dialog box and then a large browser window will launch - log into your Mailchimp account here and approve the use of the application.
    11. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
    12. If the connection test succeeds, select OK.
    Mailchimp
    OAuth [OAuth]
    https://[$DataCenter$].api.mailchimp.com
    Required Parameters
    Data Center Fill in the parameter...
    Client Id Fill in the parameter...
    Client Secret Fill in the parameter...
    Default List Id Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection
    Steps to get Mailchimp Credentials
    The simplest way to authenticate a request to the Mailchimp Marketing API is by using an API key (If you require access to Mailchimp on behalf of other Mailchimp users, you'll want to set up OAuth authentication instead)::
    1. Log into your Mailchimp account.
    2. Navigate to the API Keys section of your Mailchimp account: https://admin.mailchimp.com/account/api/
    3. In the Your API keys section of the page, click Create New Key.
    4. Give your new key a descriptive name that will remind you which application it's used for.
    5. Copy the generated key immediately and store it in a secure location. (You won’t be able to see or copy the key once you finish generating it.)
    6. Record your Mailchimp data center, since we will need it later. The data center will be located in your browser's address bar URL. If the URL is "https://us21.admin.mailchimp.com/account/api/", then your data center is "us21".
    7. Back at the connector screen, enter the data center that was recorded in step 6 into the Data Center field.
    8. Enter the API key that was recorded in step 5 into the Api Key field.
    9. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
    10. If the connection test succeeds, select OK.
    Mailchimp
    ApiKey Auth [Http]
    https://[$DataCenter$].api.mailchimp.com
    Required Parameters
    Api Key Fill in the parameter...
    Default List Id Fill in the parameter...
    Optional Parameters
    Data Center Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Mailchimp
    Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
    API Source - Select Endpoint

  10. That's it; we are done. In a few clicks we configured the call to Mailchimp using ZappySys Mailchimp Connector