MailChimp API Wrapper with support for API 1.3
Objective-C
Latest commit f4185d7 Jul 27, 2012 @amro amro don't show redirect url
Failed to load latest commit information.
ChimpKit2.xcodeproj ChimpKit2 now uses ARC and requires iOS5 Jul 16, 2012
Core don't show redirect url Jul 27, 2012
Sample Code
ChimpKit2-Info.plist Initial commit Nov 19, 2010
ChimpKit2ViewController.xib Initial commit Nov 19, 2010
ChimpKit2_Prefix.pch Initial commit Nov 19, 2010
LICENSE.txt
MainWindow.xib Initial commit Nov 19, 2010
README.markdown Update master Jul 16, 2012
main.m

README.markdown

ChimpKit2

ChimpKit2 is a simple API wrapper for interacting with MailChimp API 1.3.

Requirements

A MailChimp account and API key. You can see your API keys here.

ChimpKit2 includes requires ARC and iOS5.

Installation

Add ChimpKit2 as a submodule of your git repo by doing something like:

cd myrepo
git submodule add https://github.com/mailchimp/ChimpKit2.git Lib/ChimpKit

Usage

ChimpKit2 requests are designed for one-time use. To make a request first create an instance of ChimpKit:

ChimpKit *ck = [[ChimpKit alloc] initWithDelegate:self 
                                        andApiKey:@"<YOUR_API_KEY>"];

You may have noticed that we passed "self" as the delegate above. You should implement the "ChimpKitDelegate" protocol, which includes the following methods:

- (void)ckRequestSucceeded:(ChimpKit *)ckRequest {
    NSLog(@"HTTP Status Code: %d", [ckRequest responseStatusCode]);
    NSLog(@"Response String: %@", [ckRequest responseString]);
}

- (void)ckRequestFailed:(NSError *)error {
    NSLog(@"Response Error: %@", error);
}

Fetching data is as simple as calling callApiMethod:withParams: with the name of the desired API method on the wrapper object. Check the API documentation for details.

Canceling Requests

You can cancel an in-progress request by passing the "cancel" message:

[ck cancel];

Controlling Timeout

ChimpKit2 defaults to a 10 second timeout. You can change that (globally) to 30 seconds like so:

[ChimpKit setTimeout:30];

Fetching Lists

[ck callApiMethod:@"lists" withParams:nil];

Subscribing an Email

NSMutableDictionary *params = [NSMutableDictionary dictionary];
[params setValue:@"<YOUR_LIST_ID>" forKey:@"id"];
[params setValue:@"someemail@example.com" forKey:@"email_address"];
[params setValue:@"true" forKey:@"double_optin"];
[params setValue:@"true" forKey:@"update_existing"];

NSMutableDictionary *mergeVars = [NSMutableDictionary dictionary];
[mergeVars setValue:@"First" forKey:@"FNAME"];
[mergeVars setValue:@"Last" forKey:@"LNAME"];
[params setValue:mergeVars forKey:@"merge_vars"];

[ck callApiMethod:@"listSubscribe" withParams:params];

MailChimp now supports OAuth2 and so does ChimpKit:

//You don't have to use a navigation controller, but we'll put a cancel button on it for you if you do
CKAuthViewController *authViewController = [[CKAuthViewController alloc] initWithClientId:@"<YOUR_CLIENT_ID>" 
                                                                          andClientSecret:@"<YOUR_CLIENT_SEEKRUT>"];
authViewController.delegate = self;
UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:authViewController];
[self presentModalViewController:navigationController animated:YES];

Your delegate must implement the CKAuthViewControllerDelegate protocol. The required methods are:

- (void)ckAuthSucceededWithApiKey:(NSString *)apiKey;
- (void)ckAuthFailedWithError:(NSError *)error;

Your delegate can optionally implement:

- (void)ckAuthUserDismissedView;

If you care to know when the user taps the cancel button.

Copyrights

  • Copyright (c) 2010-2012 The Rocket Science Group. Please see LICENSE.txt for details.
  • MailChimp (c) 2001-2012 The Rocket Science Group.