Mailchimp Connector
Documentation
Version: 1
Documentation

How to read Mailchimp data in MS SQL/SSRS/Java using ZappySys Data Gateway?


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

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    MailchimpDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "Mailchimp" from the list of Popular Connectors. If "Mailchimp" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    MailchimpDSN
    Mailchimp
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Steps how to get and use 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. Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing: Start by going to Mailchimp account
    2. Navigate to the Registered Apps page in your Mailchimp account: Go to registered OAuth apps in Mailchimp
    3. Click Register An App button: Register new OAuth app in Mailchimp
    4. Fill-in the Register An App form and click Create button: Enter OAuth app details in Mailchimp
      NOTE: For Redirect URI use Redirect URI (also called "Redirect URL" or "Callback URL") given by your IT administrator or just use https://zappysys.com/oauth, if you don't have one.
    5. After successfully registering your application, you'll see the Client ID and Client Secret, record these values and store them securely: Use OAuth app to get Mailchimp data via REST API
    6. Record your Mailchimp data center, since we will need it later. The data center is 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. Now go to SSIS package or ODBC data source OAuth authentication configuration.
    8. Proceed by entering the data center into the Data Center field that was recorded in the previous step.
    9. Then enter the Client ID value into the Client ID field that you recorded in the previous step.
    10. Enter the Client Secret value into the Client Secret field that was recorded in the previous step.
    11. Click Generate Token. If proper authentication occurs, you will see a confirmation notice. If you get an error, click Yes on the dialog box and then a large browser window will launch. Then log into your Mailchimp account and approve the use of the application.
    12. Finally, hit the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
    13. If the connection test succeeds, select OK.
    14. Done! Now you can use Mailchimp Connector!

    Fill in all required parameters and set optional parameters if needed:

    MailchimpDSN
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration
    Steps how to get and use 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. Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing: Start by going to Mailchimp account
    2. Navigate to the API keys page in your Mailchimp account: Go to API Keys in Mailchimp
    3. In the Your API keys section of the page, click Create A Key button: Create new API Key in Mailchimp
    4. Give your new key a descriptive name that will remind you which application it's used for: Name API Key in Mailchimp
    5. Copy the API 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): Use API Key to get Mailchimp data via REST API
    6. Record your Mailchimp data center, since we will need it later. The data center is 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. Now go to SSIS package or ODBC data source ApiKey Auth authentication configuration.
    8. Proceed by entering the data center into the Data Center field that was recorded in the previous step.
    9. Then enter the API key into the Api Key field that you copied earlier.
    10. Finally, click the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
    11. Done! Now you can use Mailchimp Connector!

    Fill in all required parameters and set optional parameters if needed:

    MailchimpDSN
    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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Reading data from client application

  1. Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
  2. Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:

    SELECT * FROM Campaigns

Mailchimp Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Mailchimp API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Mailchimp.

Click here to find more Mailchimp Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Consume Data inside your App / Programming Language

Once you know how to load data from Mailchimp Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from Mailchimp Connector.

ODBC inside ETL / Reporting / BI Tools

ODBC inside Programming Languages

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

  1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Mailchimp without requiring extensive technical expertise or programming knowledge.

  2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Mailchimp.

  3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Mailchimp and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

  4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Mailchimp API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

  5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

  6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Mailchimp, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Mailchimp, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.